Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.messageserver.runtime.channel
Class EventDisconnected

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.runtime.channel.EventDisconnected
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventDisconnected
extends Message

Indicates that message server is disconnected.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventDisconnected create()
          Creates instance of EventDisconnected with no parameters set.
static EventDisconnected create(MessageTypes messageType, MessagePriority priority, java.lang.Integer origin, java.lang.Long timeGenerated, java.lang.Integer subscriberType, java.lang.Integer attachedDataLength, byte[] attachedData, KeyValueCollection userData, MessageKey messageKey)
          Creates instance of EventDisconnected with all parameters set.
static EventDisconnected create(MessageTypes messageType, MessagePriority priority, java.lang.Integer origin, java.lang.Long timeGenerated, java.lang.Integer subscriberType, MessageKey messageKey)
          Creates instance of EventDisconnected with required parameters set.
abstract  byte[] getAttachedData()
          Any data attached to the message
abstract  java.lang.Integer getAttachedDataLength()
          Length of the attached data
abstract  MessageKey getMessageKey()
           
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.lang.Long getTimeGenerated()
          The time when message was generated by supplier
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 setMessageKey(MessageKey messageKey)
           
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 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 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 EventDisconnected create()
Creates instance of EventDisconnected with no parameters set.

Returns:
instance of EventDisconnected

create

public static EventDisconnected create(MessageTypes messageType,
                                       MessagePriority priority,
                                       java.lang.Integer origin,
                                       java.lang.Long timeGenerated,
                                       java.lang.Integer subscriberType,
                                       java.lang.Integer attachedDataLength,
                                       byte[] attachedData,
                                       KeyValueCollection userData,
                                       MessageKey messageKey)
Creates instance of EventDisconnected with all parameters set.

Parameters:
messageType - Type of the message
priority - Priority of the message
origin - Origin of the message (ID of an application)
timeGenerated - The time when message was generated by supplier
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
messageKey - MessageKey
Returns:
instance of EventDisconnected

create

public static EventDisconnected create(MessageTypes messageType,
                                       MessagePriority priority,
                                       java.lang.Integer origin,
                                       java.lang.Long timeGenerated,
                                       java.lang.Integer subscriberType,
                                       MessageKey messageKey)
Creates instance of EventDisconnected with required parameters set.

Parameters:
messageType - Type of the message
priority - Priority of the message
origin - Origin of the message (ID of an application)
timeGenerated - The time when message was generated by supplier
subscriberType - Subscription: Type of the message to subscribe to
messageKey - MessageKey
Returns:
instance of EventDisconnected

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

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

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

getMessageKey

public abstract MessageKey getMessageKey()

setMessageKey

public abstract void setMessageKey(MessageKey messageKey)

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.