Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.requests.objects
Class RequestGetBriefInfo

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.configuration.protocol.confserver.requests.objects.RequestGetBriefInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestGetBriefInfo
extends Message

Requests brief information about the object(s) specified by ObjectType and Filter.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetBriefInfo create()
          Creates instance of RequestGetBriefInfo with no parameters set.
static RequestGetBriefInfo create(java.lang.Integer objectType, KeyValueCollection filter)
          Creates instance of RequestGetBriefInfo with all parameters set.
abstract  KeyValueCollection getFilter()
          Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  void setFilter(KeyValueCollection filter)
          Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
abstract  void setObjectType(int objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setObjectType(java.lang.Integer objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestGetBriefInfo create()
Creates instance of RequestGetBriefInfo with no parameters set.

Returns:
instance of RequestGetBriefInfo

create

public static RequestGetBriefInfo create(java.lang.Integer objectType,
                                         KeyValueCollection filter)
Creates instance of RequestGetBriefInfo with all parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
filter - Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise noted
Returns:
instance of RequestGetBriefInfo

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getObjectType

public abstract java.lang.Integer getObjectType()
Type of configuration object as defined in ConfServerObject enum

Returns:
property value

setObjectType

public abstract void setObjectType(java.lang.Integer objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

setObjectType

public abstract void setObjectType(int objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

getFilter

public abstract KeyValueCollection getFilter()
Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise noted

Returns:
property value

setFilter

public abstract void setFilter(KeyValueCollection filter)
Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise noted

Parameters:
filter - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.