|
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.interactionmanagement.EventCustomReporting
public abstract class EventCustomReporting
The purpose is to provide the ability for Interaction Server clients to generate their own custom reporting events that can be consumed by real time or historical reporting to calculate or generate more relevant and accurate business reports.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventCustomReporting |
create()
Creates instance of EventCustomReporting with no parameters set. |
static EventCustomReporting |
create(java.lang.Integer customEventId,
java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String mediaTypeName,
KeyValueCollection eventContent,
java.util.Date eventTime,
InteractionProperties interaction,
PartyInfo party,
ReasonInfo reason)
Creates instance of EventCustomReporting with all parameters set. |
abstract java.lang.Integer |
getCustomEventId()
|
abstract KeyValueCollection |
getEventContent()
|
abstract java.util.Date |
getEventTime()
Date and time of the event. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract InteractionProperties |
getInteraction()
|
abstract java.lang.String |
getMediaTypeName()
Media type name. |
abstract PartyInfo |
getParty()
|
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 void |
setCustomEventId(int customEventId)
|
abstract void |
setCustomEventId(java.lang.Integer customEventId)
|
abstract void |
setEventContent(KeyValueCollection eventContent)
|
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 |
setInteraction(InteractionProperties interaction)
|
abstract void |
setMediaTypeName(java.lang.String mediaTypeName)
Media type name. |
abstract void |
setParty(PartyInfo party)
|
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. |
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 EventCustomReporting create()
public static EventCustomReporting create(java.lang.Integer customEventId, java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String mediaTypeName, KeyValueCollection eventContent, java.util.Date eventTime, InteractionProperties interaction, PartyInfo party, ReasonInfo reason)
customEventId
- proxyClientId
- The identifier of the client of proxy.extension
- Extensions.mediaTypeName
- Name of the new media added.eventContent
- eventTime
- Date and time of the event.interaction
- Interactionparty
- Partyreason
- Reason.
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 getCustomEventId()
public abstract void setCustomEventId(java.lang.Integer customEventId)
customEventId
- new value of the propertypublic abstract void setCustomEventId(int customEventId)
customEventId
- new value of the propertypublic abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.lang.String getMediaTypeName()
public abstract void setMediaTypeName(java.lang.String mediaTypeName)
public abstract KeyValueCollection getEventContent()
public abstract void setEventContent(KeyValueCollection eventContent)
eventContent
- new value of the propertypublic abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract InteractionProperties getInteraction()
public abstract void setInteraction(InteractionProperties interaction)
public abstract PartyInfo getParty()
public abstract void setParty(PartyInfo party)
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 |