|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventActivityReport
public abstract class EventActivityReport
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
proxyClientId
- The identifier of the client of proxy.partyType
- Party type: 1 - party is a strategy, 2 - party is a resourcetenantId
- 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 - ignoredinteractionsOutOfFocus
- List of interactions that have lost focus. Each key-value pair is represented as: key - interactionid, value - ignoredextension
- Extensions.reason
- Reason.
public static EventActivityReport create(KeyValueCollection interactionsInFocus, KeyValueCollection interactionsOutOfFocus)
interactionsInFocus
- List of interactions that have received focus. Each key-value pair is represented as: key - interactionid, value - ignoredinteractionsOutOfFocus
- List of interactions that have lost focus. Each key-value pair is represented as: key - interactionid, value - ignored
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract PartyType getPartyType()
public abstract void setPartyType(PartyType partyType)
public abstract java.lang.Integer getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public abstract java.lang.String getPlaceId()
public abstract void setPlaceId(java.lang.String placeId)
public abstract java.lang.String getAgentId()
public abstract void setAgentId(java.lang.String agentId)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract KeyValueCollection getInteractionsInFocus()
public abstract void setInteractionsInFocus(KeyValueCollection interactionsInFocus)
interactionsInFocus
- new value of the propertypublic abstract KeyValueCollection getInteractionsOutOfFocus()
public abstract void setInteractionsOutOfFocus(KeyValueCollection interactionsOutOfFocus)
interactionsOutOfFocus
- new value of the propertypublic abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract ReasonInfo getReason()
public abstract void setReason(ReasonInfo reason)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |