Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.configuration.protocol.confserver.events
Class EventObjectsSent

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.DataObject
      extended bycom.genesyslab.platform.commons.protocol.Message
          extended bycom.genesyslab.platform.configuration.protocol.confserver.events.EventObjectsSent
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventObjectsSent
extends Message

Indicates that Configuration Server has finished sending data in response to a RequestReadObjects message. The amount of data that Configuration Server needs to return in response to a RequestReadObjects message may be more than can be carried in a single EventObjectsRead. Because of this, Configuration Server sends an EventObjectsSent after it has finished sending this data, so that client applications will know that it has completed the request. Your applications must watch for this message in order to verify that they have received all of the data they requested.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventObjectsSent create()
          Creates instance of EventObjectsSent with no parameters set.
static EventObjectsSent create(java.lang.Integer objectType)
          Creates instance of EventObjectsSent with all parameters set.
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  java.lang.Integer getReferenceId()
          Reference id to connect responce to request.
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 responce to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference id to connect responce to request.
 
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 EventObjectsSent create()
Creates instance of EventObjectsSent with no parameters set.

Returns:
instance of EventObjectsSent

create

public static EventObjectsSent create(java.lang.Integer objectType)
Creates instance of EventObjectsSent with all parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
Returns:
instance of EventObjectsSent

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

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

Configuration Platform SDK 7.6 API Reference

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