|
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.RequestRegisterNotification
public abstract class RequestRegisterNotification
Registers application to receive notifications on the objects specified in the Subscription list.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestRegisterNotification |
create()
Creates instance of RequestRegisterNotification with no parameters set. |
static RequestRegisterNotification |
create(KeyValueCollection subscription)
Creates instance of RequestRegisterNotification with all parameters set. |
abstract java.lang.Integer |
getReferenceId()
Reference ID to connect response to request. |
abstract KeyValueCollection |
getSubscription()
Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded - let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 - means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 - means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications. |
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. |
abstract void |
setSubscription(KeyValueCollection subscription)
Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded - let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 - means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 - means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications. |
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 RequestRegisterNotification create()
public static RequestRegisterNotification create(KeyValueCollection subscription)
subscription
- Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded - let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 - means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 - means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract KeyValueCollection getSubscription()
public abstract void setSubscription(KeyValueCollection subscription)
subscription
- 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 |