|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.configuration.protocol.confserver.requests.objects.RequestGetBriefInfo
public abstract class RequestGetBriefInfo
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestGetBriefInfo create()
public static RequestGetBriefInfo create(java.lang.Integer objectType, KeyValueCollection filter)
objectType
- Type of configuration object as defined in ConfServerObject enumfilter
- 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
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getObjectType()
public abstract void setObjectType(java.lang.Integer objectType)
objectType
- new value of the propertypublic abstract void setObjectType(int objectType)
objectType
- new value of the propertypublic abstract KeyValueCollection getFilter()
public abstract void setFilter(KeyValueCollection filter)
filter
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |