Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.solutioncontrolserver.events
Class EventEnvironmentInfo

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.events.EventEnvironmentInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventEnvironmentInfo
extends Message

Answer to RequestRetrieveEnvironment.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventEnvironmentInfo create()
          Creates instance of EventEnvironmentInfo with no parameters set.
static EventEnvironmentInfo create(java.lang.Integer client, KeyValueCollection eventData)
          Creates instance of EventEnvironmentInfo with all parameters set.
abstract  java.lang.Integer getClient()
          no desc.
abstract  KeyValueCollection getEventData()
          This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData).
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setClient(int client)
          no desc.
abstract  void setClient(java.lang.Integer client)
          no desc.
abstract  void setEventData(KeyValueCollection eventData)
          This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData).
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 EventEnvironmentInfo create()
Creates instance of EventEnvironmentInfo with no parameters set.

Returns:
instance of EventEnvironmentInfo

create

public static EventEnvironmentInfo create(java.lang.Integer client,
                                          KeyValueCollection eventData)
Creates instance of EventEnvironmentInfo with all parameters set.

Parameters:
client - no desc.
eventData - This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1002.
Returns:
instance of EventEnvironmentInfo

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.


getClient

public abstract java.lang.Integer getClient()
no desc.

Returns:
property value

setClient

public abstract void setClient(java.lang.Integer client)
no desc.

Parameters:
client - new value of the property

setClient

public abstract void setClient(int client)
no desc.

Parameters:
client - new value of the property

getEventData

public abstract KeyValueCollection getEventData()
This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1002.

Returns:
property value

setEventData

public abstract void setEventData(KeyValueCollection eventData)
This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1002.

Parameters:
eventData - new value of the property

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.