Platform SDK Java 8.5 API Reference

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

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

public abstract class EventError
extends Message

Indicates that exception occurred on message server socket


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventError create()
          Creates instance of EventError with no parameters set.
static EventError create(MessageTypes messageType, java.util.Date time, java.lang.Integer subscriberType)
          Creates instance of EventError with required parameters set.
static EventError create(MessageTypes messageType, java.util.Date time, java.lang.Integer subscriberType, java.lang.Integer attachedDataLength, byte[] attachedData, KeyValueCollection userData)
          Creates instance of EventError with all parameters set.
abstract  byte[] getAttachedData()
          Any data attached to the message
abstract  java.lang.Integer getAttachedDataLength()
          Length of the attached data
abstract  MessageTypes getMessageType()
          The message type.
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  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 setMessageType(MessageTypes messageType)
          The message type.
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 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 EventError create()
Creates instance of EventError with no parameters set.

Returns:
instance of EventError

create

public static EventError create(MessageTypes messageType,
                                java.util.Date time,
                                java.lang.Integer subscriberType,
                                java.lang.Integer attachedDataLength,
                                byte[] attachedData,
                                KeyValueCollection userData)
Creates instance of EventError with all parameters set.

Parameters:
messageType - Type of the message
time - Note that server sends this value in UTC format always.
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
Returns:
instance of EventError

create

public static EventError create(MessageTypes messageType,
                                java.util.Date time,
                                java.lang.Integer subscriberType)
Creates instance of EventError with required parameters set.

Parameters:
messageType - Type of the message
time - Note that server sends this value in UTC format always.
subscriberType - Subscription: Type of the message to subscribe to
Returns:
instance of EventError

getMessageType

public abstract MessageTypes getMessageType()
The message type.


setMessageType

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


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

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

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.