Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.solutioncontrolserver.requests
Class RequestSubscribe

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.RequestSubscribe
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestSubscribe
extends Message

Subscription request. Subscribes to notification events for configuration objects that receive a status change.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSubscribe create()
          Creates instance of RequestSubscribe with no parameters set.
static RequestSubscribe create(ControlObjectType controlObjectType, java.lang.Integer controlObjectId)
          Creates instance of RequestSubscribe with all parameters set.
abstract  java.lang.Integer getControlObjectId()
          Attribute description: Object DBID.
abstract  ControlObjectType getControlObjectType()
          Object type.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setControlObjectId(int controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectId(java.lang.Integer controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectType(ControlObjectType controlObjectType)
          Object type.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the 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 RequestSubscribe create()
Creates instance of RequestSubscribe with no parameters set.

Returns:
instance of RequestSubscribe

create

public static RequestSubscribe create(ControlObjectType controlObjectType,
                                      java.lang.Integer controlObjectId)
Creates instance of RequestSubscribe with all parameters set.

Parameters:
controlObjectType - Object type.
controlObjectId - Application ControlObjectId.
Returns:
instance of RequestSubscribe

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getControlObjectType

public abstract ControlObjectType getControlObjectType()
Object type.

Returns:
property value

setControlObjectType

public abstract void setControlObjectType(ControlObjectType controlObjectType)
Object type.

Parameters:
controlObjectType - new value of the property

getControlObjectId

public abstract java.lang.Integer getControlObjectId()
Attribute description: Object DBID.


setControlObjectId

public abstract void setControlObjectId(java.lang.Integer controlObjectId)
Attribute description: Object DBID.


setControlObjectId

public abstract void setControlObjectId(int controlObjectId)
Attribute description: Object DBID.


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.