Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.messageserver.events
Class EventSubscription

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

public abstract class EventSubscription
extends Message

Event is returned with subscribed info on a following subscribing messages:


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventSubscription create()
          Creates instance of EventSubscription with no parameters set.
static EventSubscription create(MessageTypes messageType, MessagePriority priority, java.lang.Integer origin, java.util.Date time, java.lang.Integer usec, java.lang.Integer subscriberType, java.lang.Integer attachedDataLength, byte[] attachedData, KeyValueCollection userData, java.lang.Long timeGenerated, KeyValueCollection logParameters, java.lang.Integer messageGuid2, java.lang.Integer messageGuid3, byte[] messageGuid4, java.lang.Integer keyFlags, java.lang.Integer keyInteger, java.lang.Integer keyLong, java.lang.String keyString, KeyValueCollection keyKVList)
          Creates instance of EventSubscription with all parameters set.
abstract  byte[] getAttachedData()
          Any data attached to the message
abstract  java.lang.Integer getAttachedDataLength()
          Length of the attached data
abstract  java.lang.Integer getKeyFlags()
          Simple key: flags.
abstract  java.lang.Integer getKeyInteger()
          Simple key: integer value
abstract  KeyValueCollection getKeyKVList()
          KVList key
abstract  java.lang.Integer getKeyLong()
          Simple key: unsigned long value
abstract  java.lang.String getKeyString()
          Simple key: string value
abstract  KeyValueCollection getLogParameters()
           
abstract  java.lang.Integer getMessageGuid1()
          Message GUID - Data1 member.
abstract  java.lang.Integer getMessageGuid2()
          Message GUID - Data2 member
abstract  java.lang.Integer getMessageGuid3()
          Message GUID - Data3 member
abstract  byte[] getMessageGuid4()
          Message GUID - Data4 member
abstract  MessageTypes getMessageType()
          The message type.
abstract  java.lang.Integer getOrigin()
          Origin of the message (ID of an application)
abstract  MessagePriority getPriority()
          Priority of the message
abstract  java.lang.Integer getSubscriberType()
          Subscription: Type of the message to subscribe to
abstract  java.util.Date getTime()
          Note that server sends this value in UTC format always.
abstract  java.lang.Long getTimeGenerated()
          The time when message was generated by supplier
abstract  java.lang.Integer getUsec()
           
abstract  KeyValueCollection getUserData()
          Attached data packed in TKVList
abstract  void setAttachedData(byte[] attachedData)
          Any data attached to the message
abstract  void setAttachedDataLength(int attachedDataLength)
          Length of the attached data
abstract  void setAttachedDataLength(java.lang.Integer attachedDataLength)
          Length of the attached data
abstract  void setKeyFlags(int keyFlags)
          Simple key: flags.
abstract  void setKeyFlags(java.lang.Integer keyFlags)
          Simple key: flags.
abstract  void setKeyInteger(int keyInteger)
          Simple key: integer value
abstract  void setKeyInteger(java.lang.Integer keyInteger)
          Simple key: integer value
abstract  void setKeyKVList(KeyValueCollection keyKVList)
          KVList key
abstract  void setKeyLong(int keyLong)
          Simple key: unsigned long value
abstract  void setKeyLong(java.lang.Integer keyLong)
          Simple key: unsigned long value
abstract  void setKeyString(java.lang.String keyString)
          Simple key: string value
abstract  void setLogParameters(KeyValueCollection logParameters)
           
abstract  void setMessageGuid1(int messageGuid1)
          Message GUID - Data1 member.
abstract  void setMessageGuid1(java.lang.Integer messageGuid1)
          Message GUID - Data1 member.
abstract  void setMessageGuid2(int messageGuid2)
          Message GUID - Data2 member
abstract  void setMessageGuid2(java.lang.Integer messageGuid2)
          Message GUID - Data2 member
abstract  void setMessageGuid3(int messageGuid3)
          Message GUID - Data3 member
abstract  void setMessageGuid3(java.lang.Integer messageGuid3)
          Message GUID - Data3 member
abstract  void setMessageGuid4(byte[] messageGuid4)
          Message GUID - Data4 member
abstract  void setMessageType(MessageTypes messageType)
          The message type.
abstract  void setOrigin(int origin)
          Origin of the message (ID of an application)
abstract  void setOrigin(java.lang.Integer origin)
          Origin of the message (ID of an application)
abstract  void setPriority(MessagePriority priority)
          Priority of the message
abstract  void setSubscriberType(int subscriberType)
          Subscription: Type of the message to subscribe to
abstract  void setSubscriberType(java.lang.Integer subscriberType)
          Subscription: Type of the message to subscribe to
abstract  void setTime(java.util.Date time)
          Note that server sends this value in UTC format always.
abstract  void setTimeGenerated(long timeGenerated)
          The time when message was generated by supplier
abstract  void setTimeGenerated(java.lang.Long timeGenerated)
          The time when message was generated by supplier
abstract  void setUsec(int usec)
           
abstract  void setUsec(java.lang.Integer usec)
           
abstract  void setUserData(KeyValueCollection userData)
          Attached data packed in TKVList
 
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 EventSubscription create()
Creates instance of EventSubscription with no parameters set.

Returns:
instance of EventSubscription

create

public static EventSubscription create(MessageTypes messageType,
                                       MessagePriority priority,
                                       java.lang.Integer origin,
                                       java.util.Date time,
                                       java.lang.Integer usec,
                                       java.lang.Integer subscriberType,
                                       java.lang.Integer attachedDataLength,
                                       byte[] attachedData,
                                       KeyValueCollection userData,
                                       java.lang.Long timeGenerated,
                                       KeyValueCollection logParameters,
                                       java.lang.Integer messageGuid2,
                                       java.lang.Integer messageGuid3,
                                       byte[] messageGuid4,
                                       java.lang.Integer keyFlags,
                                       java.lang.Integer keyInteger,
                                       java.lang.Integer keyLong,
                                       java.lang.String keyString,
                                       KeyValueCollection keyKVList)
Creates instance of EventSubscription with all parameters set.

Parameters:
messageType - Type of the message
priority - Priority of the message
origin - Origin of the message (ID of an application)
time - Note that server sends this value in UTC format always.
usec - Usec
subscriberType - Subscription: Type of the message to subscribe to
attachedDataLength - Length of the attached data
attachedData - Any data attached to the message
userData - Attached data packed in TKVList
timeGenerated - The time when message was generated by supplier
logParameters - LogParameters
messageGuid2 - Message GUID - Data2 member
messageGuid3 - Message GUID - Data3 member
messageGuid4 - Message GUID - Data4 member
keyFlags - Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|')
keyInteger - Simple key: integer value
keyLong - Simple key: unsigned long value
keyString - Simple key: string value
keyKVList - KVList key
Returns:
instance of EventSubscription

getMessageType

public abstract MessageTypes getMessageType()
The message type.


setMessageType

public abstract void setMessageType(MessageTypes messageType)
The message type.


getPriority

public abstract MessagePriority getPriority()
Priority of the message

Returns:
property value

setPriority

public abstract void setPriority(MessagePriority priority)
Priority of the message

Parameters:
priority - new value of the property

getOrigin

public abstract java.lang.Integer getOrigin()
Origin of the message (ID of an application)

Returns:
property value

setOrigin

public abstract void setOrigin(java.lang.Integer origin)
Origin of the message (ID of an application)

Parameters:
origin - new value of the property

setOrigin

public abstract void setOrigin(int origin)
Origin of the message (ID of an application)

Parameters:
origin - new value of the property

getTime

public abstract java.util.Date getTime()
Note that server sends this value in UTC format always.

Returns:
property value

setTime

public abstract void setTime(java.util.Date time)
Note that server sends this value in UTC format always.

Parameters:
time - new value of the property

getUsec

public abstract java.lang.Integer getUsec()

setUsec

public abstract void setUsec(java.lang.Integer usec)

setUsec

public abstract void setUsec(int usec)

getSubscriberType

public abstract java.lang.Integer getSubscriberType()
Subscription: Type of the message to subscribe to

Returns:
property value

setSubscriberType

public abstract void setSubscriberType(java.lang.Integer subscriberType)
Subscription: Type of the message to subscribe to

Parameters:
subscriberType - new value of the property

setSubscriberType

public abstract void setSubscriberType(int subscriberType)
Subscription: Type of the message to subscribe to

Parameters:
subscriberType - new value of the property

getAttachedDataLength

public abstract java.lang.Integer getAttachedDataLength()
Length of the attached data

Returns:
property value

setAttachedDataLength

public abstract void setAttachedDataLength(java.lang.Integer attachedDataLength)
Length of the attached data

Parameters:
attachedDataLength - new value of the property

setAttachedDataLength

public abstract void setAttachedDataLength(int attachedDataLength)
Length of the attached data

Parameters:
attachedDataLength - new value of the property

getAttachedData

public abstract byte[] getAttachedData()
Any data attached to the message

Returns:
property value

setAttachedData

public abstract void setAttachedData(byte[] attachedData)
Any data attached to the message

Parameters:
attachedData - new value of the property

getUserData

public abstract KeyValueCollection getUserData()
Attached data packed in TKVList

Returns:
property value

setUserData

public abstract void setUserData(KeyValueCollection userData)
Attached data packed in TKVList

Parameters:
userData - new value of the property

getTimeGenerated

public abstract java.lang.Long getTimeGenerated()
The time when message was generated by supplier

Returns:
property value

setTimeGenerated

public abstract void setTimeGenerated(java.lang.Long timeGenerated)
The time when message was generated by supplier

Parameters:
timeGenerated - new value of the property

setTimeGenerated

public abstract void setTimeGenerated(long timeGenerated)
The time when message was generated by supplier

Parameters:
timeGenerated - new value of the property

getLogParameters

public abstract KeyValueCollection getLogParameters()

setLogParameters

public abstract void setLogParameters(KeyValueCollection logParameters)

getMessageGuid1

public abstract java.lang.Integer getMessageGuid1()
Message GUID - Data1 member.

Returns:
property value

setMessageGuid1

public abstract void setMessageGuid1(java.lang.Integer messageGuid1)
Message GUID - Data1 member.

Parameters:
messageGuid1 - new value of the property

setMessageGuid1

public abstract void setMessageGuid1(int messageGuid1)
Message GUID - Data1 member.

Parameters:
messageGuid1 - new value of the property

getMessageGuid2

public abstract java.lang.Integer getMessageGuid2()
Message GUID - Data2 member

Returns:
property value

setMessageGuid2

public abstract void setMessageGuid2(java.lang.Integer messageGuid2)
Message GUID - Data2 member

Parameters:
messageGuid2 - new value of the property

setMessageGuid2

public abstract void setMessageGuid2(int messageGuid2)
Message GUID - Data2 member

Parameters:
messageGuid2 - new value of the property

getMessageGuid3

public abstract java.lang.Integer getMessageGuid3()
Message GUID - Data3 member

Returns:
property value

setMessageGuid3

public abstract void setMessageGuid3(java.lang.Integer messageGuid3)
Message GUID - Data3 member

Parameters:
messageGuid3 - new value of the property

setMessageGuid3

public abstract void setMessageGuid3(int messageGuid3)
Message GUID - Data3 member

Parameters:
messageGuid3 - new value of the property

getMessageGuid4

public abstract byte[] getMessageGuid4()
Message GUID - Data4 member

Returns:
property value

setMessageGuid4

public abstract void setMessageGuid4(byte[] messageGuid4)
Message GUID - Data4 member

Parameters:
messageGuid4 - new value of the property

getKeyFlags

public abstract java.lang.Integer getKeyFlags()
Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|').

See Also:
KeyFlags

setKeyFlags

public abstract void setKeyFlags(java.lang.Integer keyFlags)
Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|').

See Also:
KeyFlags

setKeyFlags

public abstract void setKeyFlags(int keyFlags)
Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|').

See Also:
KeyFlags

getKeyInteger

public abstract java.lang.Integer getKeyInteger()
Simple key: integer value

Returns:
property value

setKeyInteger

public abstract void setKeyInteger(java.lang.Integer keyInteger)
Simple key: integer value

Parameters:
keyInteger - new value of the property

setKeyInteger

public abstract void setKeyInteger(int keyInteger)
Simple key: integer value

Parameters:
keyInteger - new value of the property

getKeyLong

public abstract java.lang.Integer getKeyLong()
Simple key: unsigned long value

Returns:
property value

setKeyLong

public abstract void setKeyLong(java.lang.Integer keyLong)
Simple key: unsigned long value

Parameters:
keyLong - new value of the property

setKeyLong

public abstract void setKeyLong(int keyLong)
Simple key: unsigned long value

Parameters:
keyLong - new value of the property

getKeyString

public abstract java.lang.String getKeyString()
Simple key: string value

Returns:
property value

setKeyString

public abstract void setKeyString(java.lang.String keyString)
Simple key: string value

Parameters:
keyString - new value of the property

getKeyKVList

public abstract KeyValueCollection getKeyKVList()
KVList key

Returns:
property value

setKeyKVList

public abstract void setKeyKVList(KeyValueCollection keyKVList)
KVList key

Parameters:
keyKVList - 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.