Configuration Platform SDK 7.6 API Reference

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

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

public abstract class RequestUnregisterNotification
extends Message

Unregisters application from receiving notifications on the objects specified in the Subscription list.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestUnregisterNotification create()
          Creates instance of RequestUnregisterNotification with no parameters set.
static RequestUnregisterNotification create(KeyValueCollection subscription)
          Creates instance of RequestUnregisterNotification with all parameters set.
abstract  java.lang.Integer getReferenceId()
          Reference id to connect responce 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 responce to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference id to connect responce 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
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
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 RequestUnregisterNotification create()
Creates instance of RequestUnregisterNotification with no parameters set.

Returns:
instance of RequestUnregisterNotification

create

public static RequestUnregisterNotification create(KeyValueCollection subscription)
Creates instance of RequestUnregisterNotification with all parameters set.

Parameters:
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.
Returns:
instance of RequestUnregisterNotification

getReferenceId

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

Returns:
property value

setReferenceId

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

Parameters:
referenceId - new value of the property

setReferenceId

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

Parameters:
referenceId - new value of the property

getSubscription

public 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.

Returns:
property value

setSubscription

public 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.

Parameters:
subscription - new value of the property

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.