Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver
Class InteractionProperties

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.InteractionProperties
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class InteractionProperties
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue

InteractionProperties class.


Constructor Summary
InteractionProperties()
           
 
Method Summary
static InteractionProperties create()
          Creates instance of InteractionProperties with no parameters set.
static InteractionProperties create(java.lang.String interactionId, java.lang.String interactionParentInteractionId, java.lang.String interactionType, java.lang.String interactionSubtype, java.lang.String interactionMediatype, java.lang.Integer interactionTenantId, InteractionState interactionState, java.lang.String interactionQueue, java.lang.String interactionAgentId, java.lang.String interactionGroupId, java.lang.String interactionPlaceId, java.lang.String interactionPlaceGroupId, java.util.Date interactionReceivedAt, java.util.Date interactionSubmittedAt, java.util.Date interactionDeliveredAt, java.util.Date interactionPlacedInQueueAt, java.util.Date interactionMovedToQueueAt, java.util.Date interactionAbandonedAt, java.lang.String interactionSubmittedBy, java.lang.Boolean interactionIsOnline, java.lang.Boolean interactionIsLocked, java.lang.String interactionWorkbinTypeId, KeyValueCollection interactionUserData, java.lang.String interactionSubmitSeq, java.lang.String interactionPlaceInQueueSeq, java.util.Date interactionCompletedAt, java.lang.String interactionAssignedTo, java.util.Date interactionAssignedAt, java.lang.Boolean interactionIsHeld, java.util.Date interactionHeldAt)
          Creates instance of InteractionProperties with all parameters set.
abstract  java.util.Date getInteractionAbandonedAt()
          time of abandonment
abstract  java.lang.String getInteractionAgentId()
          Employee ID of the agent who owns the workbin that the interaction has been placed in.
abstract  java.util.Date getInteractionAssignedAt()
           
abstract  java.lang.String getInteractionAssignedTo()
           
abstract  java.util.Date getInteractionCompletedAt()
           
abstract  java.util.Date getInteractionDeliveredAt()
          Date and time, set by Interaction Server, that the interaction was first delivered to the resource.
abstract  java.lang.String getInteractionGroupId()
          Agent group name of the agent group that owns the workbin that the interaction has been placed in.
abstract  java.util.Date getInteractionHeldAt()
           
abstract  java.lang.String getInteractionId()
          Identifier of the interaction being accepted.
abstract  java.lang.Boolean getInteractionIsHeld()
           
abstract  java.lang.Boolean getInteractionIsLocked()
          Values 0: not locked 1: locked by supervisor
abstract  java.lang.Boolean getInteractionIsOnline()
          Values: 0: offline 1: online
abstract  java.lang.String getInteractionMediatype()
          Media type, from Media Type Business Process.
abstract  java.util.Date getInteractionMovedToQueueAt()
          Date and time, set by Interaction Server, that the interaction was moved to another queue; i.e.
abstract  java.lang.String getInteractionParentInteractionId()
          Parent interaction identifier.
abstract  java.util.Date getInteractionPlacedInQueueAt()
          Date and time, set by Interaction Server, that the interaction was placed in queue.
abstract  java.lang.String getInteractionPlaceGroupId()
          Place group name of the place group that owns the workbin that the interaction has been placed in.
abstract  java.lang.String getInteractionPlaceId()
          Place name of the place that owns the workbin that the interaction has been placed in.
abstract  java.lang.String getInteractionPlaceInQueueSeq()
          Represents sequence number of the last EventPlacedInQueue for the interaction
abstract  java.lang.String getInteractionQueue()
          Name of the queue that the interaction is placed in.
abstract  java.util.Date getInteractionReceivedAt()
          Date and time, provided by media server, that the interaction was first received by media server; if not provided, the attribute is set by Interaction Server and is equal to InteractionSubmittedAt.
abstract  InteractionState getInteractionState()
          Values: 0: queued 1: cached (not shown to reporting) 2: routing 3: handling
abstract  java.lang.String getInteractionSubmitSeq()
          Represents sequence number of the EventInteractionSubmitted for the interaction
abstract  java.util.Date getInteractionSubmittedAt()
          Date and time, set by Interaction Server, that the interaction was first submitted to Interaction Server.
abstract  java.lang.String getInteractionSubmittedBy()
          Name of the media server that submitted the interaction, as defined in the configuration.
abstract  java.lang.String getInteractionSubtype()
          Interaction subtype, from Interaction Subtype Business Attribute.
abstract  java.lang.Integer getInteractionTenantId()
          Tenant database ID as defined in configuration.
abstract  java.lang.String getInteractionType()
          Interaction type, from Interaction Type Business Attribute.
abstract  KeyValueCollection getInteractionUserData()
          All other interaction properties are included in this key-value list.
abstract  java.lang.String getInteractionWorkbinTypeId()
          Name of the workbin that the interaction is in; one of the following attributes will also be present to indicate workbin owner: InteractionAgentId: agent workbin InteractionGroupId: agent group workbin InteractionPlaceId: place workbin InteractionPlaceGroupId: place group workbin
abstract  void setInteractionAbandonedAt(java.util.Date interactionAbandonedAt)
          time of abandonment
abstract  void setInteractionAgentId(java.lang.String interactionAgentId)
          Employee ID of the agent who owns the workbin that the interaction has been placed in.
abstract  void setInteractionAssignedAt(java.util.Date interactionAssignedAt)
           
abstract  void setInteractionAssignedTo(java.lang.String interactionAssignedTo)
           
abstract  void setInteractionCompletedAt(java.util.Date interactionCompletedAt)
           
abstract  void setInteractionDeliveredAt(java.util.Date interactionDeliveredAt)
          Date and time, set by Interaction Server, that the interaction was first delivered to the resource.
abstract  void setInteractionGroupId(java.lang.String interactionGroupId)
          Agent group name of the agent group that owns the workbin that the interaction has been placed in.
abstract  void setInteractionHeldAt(java.util.Date interactionHeldAt)
           
abstract  void setInteractionId(java.lang.String interactionId)
          Identifier of the interaction being accepted.
abstract  void setInteractionIsHeld(java.lang.Boolean interactionIsHeld)
           
abstract  void setInteractionIsLocked(java.lang.Boolean interactionIsLocked)
          Values 0: not locked 1: locked by supervisor
abstract  void setInteractionIsOnline(java.lang.Boolean interactionIsOnline)
          Values: 0: offline 1: online
abstract  void setInteractionMediatype(java.lang.String interactionMediatype)
          Media type, from Media Type Business Process.
abstract  void setInteractionMovedToQueueAt(java.util.Date interactionMovedToQueueAt)
          Date and time, set by Interaction Server, that the interaction was moved to another queue; i.e.
abstract  void setInteractionParentInteractionId(java.lang.String interactionParentInteractionId)
          Parent interaction identifier.
abstract  void setInteractionPlacedInQueueAt(java.util.Date interactionPlacedInQueueAt)
          Date and time, set by Interaction Server, that the interaction was placed in queue.
abstract  void setInteractionPlaceGroupId(java.lang.String interactionPlaceGroupId)
          Place group name of the place group that owns the workbin that the interaction has been placed in.
abstract  void setInteractionPlaceId(java.lang.String interactionPlaceId)
          Place name of the place that owns the workbin that the interaction has been placed in.
abstract  void setInteractionPlaceInQueueSeq(java.lang.String interactionPlaceInQueueSeq)
          Represents sequence number of the last EventPlacedInQueue for the interaction
abstract  void setInteractionQueue(java.lang.String interactionQueue)
          Name of the queue that the interaction is placed in.
abstract  void setInteractionReceivedAt(java.util.Date interactionReceivedAt)
          Date and time, provided by media server, that the interaction was first received by media server; if not provided, the attribute is set by Interaction Server and is equal to InteractionSubmittedAt.
abstract  void setInteractionState(InteractionState interactionState)
          Values: 0: queued 1: cached (not shown to reporting) 2: routing 3: handling
abstract  void setInteractionSubmitSeq(java.lang.String interactionSubmitSeq)
          Represents sequence number of the EventInteractionSubmitted for the interaction
abstract  void setInteractionSubmittedAt(java.util.Date interactionSubmittedAt)
          Date and time, set by Interaction Server, that the interaction was first submitted to Interaction Server.
abstract  void setInteractionSubmittedBy(java.lang.String interactionSubmittedBy)
          Name of the media server that submitted the interaction, as defined in the configuration.
abstract  void setInteractionSubtype(java.lang.String interactionSubtype)
          Interaction subtype, from Interaction Subtype Business Attribute.
abstract  void setInteractionTenantId(int interactionTenantId)
          Tenant database ID as defined in configuration.
abstract  void setInteractionTenantId(java.lang.Integer interactionTenantId)
          Tenant database ID as defined in configuration.
abstract  void setInteractionType(java.lang.String interactionType)
          Interaction type, from Interaction Type Business Attribute.
abstract  void setInteractionUserData(KeyValueCollection interactionUserData)
          All other interaction properties are included in this key-value list.
abstract  void setInteractionWorkbinTypeId(java.lang.String interactionWorkbinTypeId)
          Name of the workbin that the interaction is in; one of the following attributes will also be present to indicate workbin owner: InteractionAgentId: agent workbin InteractionGroupId: agent group workbin InteractionPlaceId: place workbin InteractionPlaceGroupId: place group workbin
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue
getProtocolDescription
 
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
 

Constructor Detail

InteractionProperties

public InteractionProperties()
Method Detail

create

public static InteractionProperties create()
Creates instance of InteractionProperties with no parameters set.

Returns:
instance of InteractionProperties

create

public static InteractionProperties create(java.lang.String interactionId,
                                           java.lang.String interactionParentInteractionId,
                                           java.lang.String interactionType,
                                           java.lang.String interactionSubtype,
                                           java.lang.String interactionMediatype,
                                           java.lang.Integer interactionTenantId,
                                           InteractionState interactionState,
                                           java.lang.String interactionQueue,
                                           java.lang.String interactionAgentId,
                                           java.lang.String interactionGroupId,
                                           java.lang.String interactionPlaceId,
                                           java.lang.String interactionPlaceGroupId,
                                           java.util.Date interactionReceivedAt,
                                           java.util.Date interactionSubmittedAt,
                                           java.util.Date interactionDeliveredAt,
                                           java.util.Date interactionPlacedInQueueAt,
                                           java.util.Date interactionMovedToQueueAt,
                                           java.util.Date interactionAbandonedAt,
                                           java.lang.String interactionSubmittedBy,
                                           java.lang.Boolean interactionIsOnline,
                                           java.lang.Boolean interactionIsLocked,
                                           java.lang.String interactionWorkbinTypeId,
                                           KeyValueCollection interactionUserData,
                                           java.lang.String interactionSubmitSeq,
                                           java.lang.String interactionPlaceInQueueSeq,
                                           java.util.Date interactionCompletedAt,
                                           java.lang.String interactionAssignedTo,
                                           java.util.Date interactionAssignedAt,
                                           java.lang.Boolean interactionIsHeld,
                                           java.util.Date interactionHeldAt)
Creates instance of InteractionProperties with all parameters set.

Parameters:
interactionId - Interaction identifier.
interactionParentInteractionId - Parent interaction identifier.
interactionType - Interaction type as defined in interaction types enumerator (system name of enumerator).
interactionSubtype - Interaction subtype as defined in interaction subtypes enumerator (system name of enumerator).
interactionMediatype - Interaction media type as defined in media types enumerator (system name of enumerator).
interactionTenantId - Tenant dbid as defined in configuration.
interactionState - Interaction state
interactionQueue - Name of the queue interaction is placed in (queue name is present even if state is not 'queued').
interactionAgentId - Employee id of the agent that owns the workbin interaction has been placed is in (if interaction was placed in the agent workbin, the attribute will be present even if state is other than 'queued').
interactionGroupId - Agent group name of the agent group that owns the workbin interaction has been placed is in (if interaction was placed in the agent group workbin, the attribute will be present even if state is other than 'queued').
interactionPlaceId - Place name of the place that owns the workbin interaction has been placed is in (if interaction was placed in the place workbin, the attribute will be present even if state is other than 'queued').
interactionPlaceGroupId - Place group name of the place group that owns the workbin interaction has been placed is in (if interaction was placed in the place group workbin, the attribute will be present even if state is other than 'queued').
interactionReceivedAt - Date and time, provided by media server, the interaction has been first received by media server; if not provided, the attribute is set by Interaction Server and is equal to attr_itx_submitted_at.
interactionSubmittedAt - Date and time, set by Interaction Server, the interaction has been first submitted to Interaction Server.
interactionDeliveredAt - Date and time, set by Interaction Server, the interaction has been first delivered to the resource.
interactionPlacedInQueueAt - Date and time, set by Interaction Server, the interaction has been placed in queue.
interactionMovedToQueueAt - Date and time, set by Interaction Server, the interaction has been moved to another queue; i.e. this time stamp is not set if interaction has been taken out of queue and then placed in the same queue.
interactionAbandonedAt - time of abandonment
interactionSubmittedBy - Name of the media server that submitted the interaction, as defined in configuration.
interactionIsOnline - 0 - interaction is offline kind of interaction, 1 - interaction is online kind of interaction; usage of this attribute is not yet fully defined.
interactionIsLocked - 0 - interaction is not locked, 1 - interaction is locked by supervisor.
interactionWorkbinTypeId - Name of the workbin.
interactionUserData - All the interaction properties.
interactionSubmitSeq - Represents sequence number of the EventInteractionSubmitted for the interaction
interactionPlaceInQueueSeq - Represents sequence number of the last EventPlacedInQueue for the interaction
interactionCompletedAt -
interactionAssignedTo -
interactionAssignedAt -
interactionIsHeld -
interactionHeldAt -
Returns:
instance of InteractionProperties

getInteractionId

public abstract java.lang.String getInteractionId()
Identifier of the interaction being accepted.


setInteractionId

public abstract void setInteractionId(java.lang.String interactionId)
Identifier of the interaction being accepted.


getInteractionParentInteractionId

public abstract java.lang.String getInteractionParentInteractionId()
Parent interaction identifier.


setInteractionParentInteractionId

public abstract void setInteractionParentInteractionId(java.lang.String interactionParentInteractionId)
Parent interaction identifier.


getInteractionType

public abstract java.lang.String getInteractionType()
Interaction type, from Interaction Type Business Attribute.


setInteractionType

public abstract void setInteractionType(java.lang.String interactionType)
Interaction type, from Interaction Type Business Attribute.


getInteractionSubtype

public abstract java.lang.String getInteractionSubtype()
Interaction subtype, from Interaction Subtype Business Attribute.


setInteractionSubtype

public abstract void setInteractionSubtype(java.lang.String interactionSubtype)
Interaction subtype, from Interaction Subtype Business Attribute.


getInteractionMediatype

public abstract java.lang.String getInteractionMediatype()
Media type, from Media Type Business Process.


setInteractionMediatype

public abstract void setInteractionMediatype(java.lang.String interactionMediatype)
Media type, from Media Type Business Process.


getInteractionTenantId

public abstract java.lang.Integer getInteractionTenantId()
Tenant database ID as defined in configuration.


setInteractionTenantId

public abstract void setInteractionTenantId(java.lang.Integer interactionTenantId)
Tenant database ID as defined in configuration.


setInteractionTenantId

public abstract void setInteractionTenantId(int interactionTenantId)
Tenant database ID as defined in configuration.


getInteractionState

public abstract InteractionState getInteractionState()
Values:


setInteractionState

public abstract void setInteractionState(InteractionState interactionState)
Values:


getInteractionQueue

public abstract java.lang.String getInteractionQueue()
Name of the queue that the interaction is placed in. This attribute is present even if the interaction is not in the queued state.


setInteractionQueue

public abstract void setInteractionQueue(java.lang.String interactionQueue)
Name of the queue that the interaction is placed in. This attribute is present even if the interaction is not in the queued state.


getInteractionAgentId

public abstract java.lang.String getInteractionAgentId()
Employee ID of the agent who owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state.


setInteractionAgentId

public abstract void setInteractionAgentId(java.lang.String interactionAgentId)
Employee ID of the agent who owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state.


getInteractionGroupId

public abstract java.lang.String getInteractionGroupId()
Agent group name of the agent group that owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state.


setInteractionGroupId

public abstract void setInteractionGroupId(java.lang.String interactionGroupId)
Agent group name of the agent group that owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state.


getInteractionPlaceId

public abstract java.lang.String getInteractionPlaceId()
Place name of the place that owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state


setInteractionPlaceId

public abstract void setInteractionPlaceId(java.lang.String interactionPlaceId)
Place name of the place that owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state


getInteractionPlaceGroupId

public abstract java.lang.String getInteractionPlaceGroupId()
Place group name of the place group that owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state.


setInteractionPlaceGroupId

public abstract void setInteractionPlaceGroupId(java.lang.String interactionPlaceGroupId)
Place group name of the place group that owns the workbin that the interaction has been placed in. This attribute is present even if the interaction is not in the queued state.


getInteractionReceivedAt

public abstract java.util.Date getInteractionReceivedAt()
Date and time, provided by media server, that the interaction was first received by media server; if not provided, the attribute is set by Interaction Server and is equal to InteractionSubmittedAt.


setInteractionReceivedAt

public abstract void setInteractionReceivedAt(java.util.Date interactionReceivedAt)
Date and time, provided by media server, that the interaction was first received by media server; if not provided, the attribute is set by Interaction Server and is equal to InteractionSubmittedAt.


getInteractionSubmittedAt

public abstract java.util.Date getInteractionSubmittedAt()
Date and time, set by Interaction Server, that the interaction was first submitted to Interaction Server.


setInteractionSubmittedAt

public abstract void setInteractionSubmittedAt(java.util.Date interactionSubmittedAt)
Date and time, set by Interaction Server, that the interaction was first submitted to Interaction Server.


getInteractionDeliveredAt

public abstract java.util.Date getInteractionDeliveredAt()
Date and time, set by Interaction Server, that the interaction was first delivered to the resource.


setInteractionDeliveredAt

public abstract void setInteractionDeliveredAt(java.util.Date interactionDeliveredAt)
Date and time, set by Interaction Server, that the interaction was first delivered to the resource.


getInteractionPlacedInQueueAt

public abstract java.util.Date getInteractionPlacedInQueueAt()
Date and time, set by Interaction Server, that the interaction was placed in queue.


setInteractionPlacedInQueueAt

public abstract void setInteractionPlacedInQueueAt(java.util.Date interactionPlacedInQueueAt)
Date and time, set by Interaction Server, that the interaction was placed in queue.


getInteractionMovedToQueueAt

public abstract java.util.Date getInteractionMovedToQueueAt()
Date and time, set by Interaction Server, that the interaction was moved to another queue; i.e. this time stamp is not set if the interaction was taken out of queue and then placed back in the same queue.


setInteractionMovedToQueueAt

public abstract void setInteractionMovedToQueueAt(java.util.Date interactionMovedToQueueAt)
Date and time, set by Interaction Server, that the interaction was moved to another queue; i.e. this time stamp is not set if the interaction was taken out of queue and then placed back in the same queue.


getInteractionAbandonedAt

public abstract java.util.Date getInteractionAbandonedAt()
time of abandonment

Returns:
property value

setInteractionAbandonedAt

public abstract void setInteractionAbandonedAt(java.util.Date interactionAbandonedAt)
time of abandonment

Parameters:
interactionAbandonedAt - new value of the property

getInteractionSubmittedBy

public abstract java.lang.String getInteractionSubmittedBy()
Name of the media server that submitted the interaction, as defined in the configuration.


setInteractionSubmittedBy

public abstract void setInteractionSubmittedBy(java.lang.String interactionSubmittedBy)
Name of the media server that submitted the interaction, as defined in the configuration.


getInteractionIsOnline

public abstract java.lang.Boolean getInteractionIsOnline()
Values:


setInteractionIsOnline

public abstract void setInteractionIsOnline(java.lang.Boolean interactionIsOnline)
Values:


getInteractionIsLocked

public abstract java.lang.Boolean getInteractionIsLocked()
Values


setInteractionIsLocked

public abstract void setInteractionIsLocked(java.lang.Boolean interactionIsLocked)
Values


getInteractionWorkbinTypeId

public abstract java.lang.String getInteractionWorkbinTypeId()
Name of the workbin that the interaction is in; one of the following attributes will also be present to indicate workbin owner:


setInteractionWorkbinTypeId

public abstract void setInteractionWorkbinTypeId(java.lang.String interactionWorkbinTypeId)
Name of the workbin that the interaction is in; one of the following attributes will also be present to indicate workbin owner:


getInteractionUserData

public abstract KeyValueCollection getInteractionUserData()
All other interaction properties are included in this key-value list.


setInteractionUserData

public abstract void setInteractionUserData(KeyValueCollection interactionUserData)
All other interaction properties are included in this key-value list.


getInteractionSubmitSeq

public abstract java.lang.String getInteractionSubmitSeq()
Represents sequence number of the EventInteractionSubmitted for the interaction

Returns:
property value

setInteractionSubmitSeq

public abstract void setInteractionSubmitSeq(java.lang.String interactionSubmitSeq)
Represents sequence number of the EventInteractionSubmitted for the interaction

Parameters:
interactionSubmitSeq - new value of the property

getInteractionPlaceInQueueSeq

public abstract java.lang.String getInteractionPlaceInQueueSeq()
Represents sequence number of the last EventPlacedInQueue for the interaction

Returns:
property value

setInteractionPlaceInQueueSeq

public abstract void setInteractionPlaceInQueueSeq(java.lang.String interactionPlaceInQueueSeq)
Represents sequence number of the last EventPlacedInQueue for the interaction

Parameters:
interactionPlaceInQueueSeq - new value of the property

getInteractionCompletedAt

public abstract java.util.Date getInteractionCompletedAt()
Returns:
property value

setInteractionCompletedAt

public abstract void setInteractionCompletedAt(java.util.Date interactionCompletedAt)
Parameters:
interactionCompletedAt - new value of the property

getInteractionAssignedTo

public abstract java.lang.String getInteractionAssignedTo()
Returns:
property value

setInteractionAssignedTo

public abstract void setInteractionAssignedTo(java.lang.String interactionAssignedTo)
Parameters:
interactionAssignedTo - new value of the property

getInteractionAssignedAt

public abstract java.util.Date getInteractionAssignedAt()
Returns:
property value

setInteractionAssignedAt

public abstract void setInteractionAssignedAt(java.util.Date interactionAssignedAt)
Parameters:
interactionAssignedAt - new value of the property

getInteractionIsHeld

public abstract java.lang.Boolean getInteractionIsHeld()
Returns:
property value

setInteractionIsHeld

public abstract void setInteractionIsHeld(java.lang.Boolean interactionIsHeld)
Parameters:
interactionIsHeld - new value of the property

getInteractionHeldAt

public abstract java.util.Date getInteractionHeldAt()
Returns:
property value

setInteractionHeldAt

public abstract void setInteractionHeldAt(java.util.Date interactionHeldAt)
Parameters:
interactionHeldAt - 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.