Platform SDK Java 8.5 API Reference

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

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

public abstract class EventActivityReport
extends Message

The purpose is to provide the means for an agent application to report in focus/out of focus interactions states.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventActivityReport create()
          Creates instance of EventActivityReport with no parameters set.
static EventActivityReport create(java.lang.Integer proxyClientId, PartyType partyType, java.lang.Integer tenantId, java.lang.String placeId, java.lang.String agentId, java.util.Date eventTime, KeyValueCollection interactionsInFocus, KeyValueCollection interactionsOutOfFocus, KeyValueCollection extension, ReasonInfo reason)
          Creates instance of EventActivityReport with all parameters set.
static EventActivityReport create(KeyValueCollection interactionsInFocus, KeyValueCollection interactionsOutOfFocus)
          Creates instance of EventActivityReport with required parameters set.
abstract  java.lang.String getAgentId()
          Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getInteractionsInFocus()
          List of interactions that have received focus.
abstract  KeyValueCollection getInteractionsOutOfFocus()
          List of interactions that have lost focus.
abstract  PartyType getPartyType()
          Values: 1: Party is a strategy. 2: Party is a resource.
abstract  java.lang.String getPlaceId()
          Place identifier of the resource, if the Party is a resource.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.Integer getTenantId()
          Tenant identifier of the Party (database ID from the configuration).
abstract  void setAgentId(java.lang.String agentId)
          Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.
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 setInteractionsInFocus(KeyValueCollection interactionsInFocus)
          List of interactions that have received focus.
abstract  void setInteractionsOutOfFocus(KeyValueCollection interactionsOutOfFocus)
          List of interactions that have lost focus.
abstract  void setPartyType(PartyType partyType)
          Values: 1: Party is a strategy. 2: Party is a resource.
abstract  void setPlaceId(java.lang.String placeId)
          Place identifier of the resource, if the Party is a resource.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReason(ReasonInfo reason)
          This property has been deprecated in all events.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setTenantId(int tenantId)
          Tenant identifier of the Party (database ID from the configuration).
abstract  void setTenantId(java.lang.Integer tenantId)
          Tenant identifier of the Party (database ID from the configuration).
 
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 EventActivityReport create()
Creates instance of EventActivityReport with no parameters set.

Returns:
instance of EventActivityReport

create

public static EventActivityReport create(java.lang.Integer proxyClientId,
                                         PartyType partyType,
                                         java.lang.Integer tenantId,
                                         java.lang.String placeId,
                                         java.lang.String agentId,
                                         java.util.Date eventTime,
                                         KeyValueCollection interactionsInFocus,
                                         KeyValueCollection interactionsOutOfFocus,
                                         KeyValueCollection extension,
                                         ReasonInfo reason)
Creates instance of EventActivityReport with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
partyType - Party type: 1 - party is a strategy, 2 - party is a resource
tenantId - Tenant identifier of the party (dbid from the configuration).
placeId - Place identifier of the resource, if party is a resource.
agentId - Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.
eventTime - Date and time of the event.
interactionsInFocus - List of interactions that have received focus. Each key-value pair is represented as: key - interactionid, value - ignored
interactionsOutOfFocus - List of interactions that have lost focus. Each key-value pair is represented as: key - interactionid, value - ignored
extension - Extensions.
reason - Reason.
Returns:
instance of EventActivityReport

create

public static EventActivityReport create(KeyValueCollection interactionsInFocus,
                                         KeyValueCollection interactionsOutOfFocus)
Creates instance of EventActivityReport with required parameters set.

Parameters:
interactionsInFocus - List of interactions that have received focus. Each key-value pair is represented as: key - interactionid, value - ignored
interactionsOutOfFocus - List of interactions that have lost focus. Each key-value pair is represented as: key - interactionid, value - ignored
Returns:
instance of EventActivityReport

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.


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.


getPartyType

public abstract PartyType getPartyType()
Values:


setPartyType

public abstract void setPartyType(PartyType partyType)
Values:


getTenantId

public abstract java.lang.Integer getTenantId()
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration).


getPlaceId

public abstract java.lang.String getPlaceId()
Place identifier of the resource, if the Party is a resource.


setPlaceId

public abstract void setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource.


getAgentId

public abstract java.lang.String getAgentId()
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.


setAgentId

public abstract void setAgentId(java.lang.String agentId)
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.


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.


getInteractionsInFocus

public abstract KeyValueCollection getInteractionsInFocus()
List of interactions that have received focus. Each key-value pair is represented as: key - interactionid, value - ignored

Returns:
property value

setInteractionsInFocus

public abstract void setInteractionsInFocus(KeyValueCollection interactionsInFocus)
List of interactions that have received focus. Each key-value pair is represented as: key - interactionid, value - ignored

Parameters:
interactionsInFocus - new value of the property

getInteractionsOutOfFocus

public abstract KeyValueCollection getInteractionsOutOfFocus()
List of interactions that have lost focus. Each key-value pair is represented as: key - interactionid, value - ignored

Returns:
property value

setInteractionsOutOfFocus

public abstract void setInteractionsOutOfFocus(KeyValueCollection interactionsOutOfFocus)
List of interactions that have lost focus. Each key-value pair is represented as: key - interactionid, value - ignored

Parameters:
interactionsOutOfFocus - new value of the property

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:


getReason

public abstract ReasonInfo getReason()
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


setReason

public abstract void setReason(ReasonInfo reason)
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


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.