Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventHint

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventHint
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventHint
extends Message

The purpose of the event is to advise a client about certain conditions.The client may choose to react or ignore the hint. In particular, this event is used to advise Stat Server about massive logout event due to proxy disconnect.A pair of events indicates the beginning and the end of the condition.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventHint create()
          Creates instance of EventHint with no parameters set.
static EventHint create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.util.Date eventTime, java.lang.String hint, java.lang.Integer conditionStarting)
          Creates instance of EventHint with all parameters set.
abstract  java.lang.Integer getConditionStarting()
          [optional] 0 - indicates the end of the condition.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.String getHint()
          [mandatory] The name (unique identifier) of the condition
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  void setConditionStarting(int conditionStarting)
          [optional] 0 - indicates the end of the condition.
abstract  void setConditionStarting(java.lang.Integer conditionStarting)
          [optional] 0 - indicates the end of the condition.
abstract  void setEventTime(java.util.Date eventTime)
          Date and time of the event.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setHint(java.lang.String hint)
          [mandatory] The name (unique identifier) of the condition
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
 
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 EventHint create()
Creates instance of EventHint with no parameters set.

Returns:
instance of EventHint

create

public static EventHint create(java.lang.Integer proxyClientId,
                               KeyValueCollection extension,
                               java.util.Date eventTime,
                               java.lang.String hint,
                               java.lang.Integer conditionStarting)
Creates instance of EventHint with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
eventTime - Date and time of the event.
hint - [mandatory] The name (unique identifier) of the condition
conditionStarting - [optional] 0 - indicates the end of the condition. 1 indicates the beginning of the condition. Default 0.
Returns:
instance of EventHint

getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


getEventTime

public abstract java.util.Date getEventTime()
Date and time of the event.


setEventTime

public abstract void setEventTime(java.util.Date eventTime)
Date and time of the event.


getHint

public abstract java.lang.String getHint()
[mandatory] The name (unique identifier) of the condition

Returns:
property value

setHint

public abstract void setHint(java.lang.String hint)
[mandatory] The name (unique identifier) of the condition

Parameters:
hint - new value of the property

getConditionStarting

public abstract java.lang.Integer getConditionStarting()
[optional] 0 - indicates the end of the condition. 1 indicates the beginning of the condition. Default 0.

Returns:
property value

setConditionStarting

public abstract void setConditionStarting(java.lang.Integer conditionStarting)
[optional] 0 - indicates the end of the condition. 1 indicates the beginning of the condition. Default 0.

Parameters:
conditionStarting - new value of the property

setConditionStarting

public abstract void setConditionStarting(int conditionStarting)
[optional] 0 - indicates the end of the condition. 1 indicates the beginning of the condition. Default 0.

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