Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement
Class RequestWorkbinNotifications

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.requests.interactionmanagement.RequestWorkbinNotifications
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestWorkbinNotifications
extends Message

With this request, an agent application can subscribe to be notified of changes to the content of a specified workbin. The request applies to place or agent workbins only, not to agent group or place group workbins.

Direction: From agent application to Interaction Server


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestWorkbinNotifications create()
          Creates instance of RequestWorkbinNotifications with no parameters set.
static RequestWorkbinNotifications create(java.lang.Integer proxyClientId, KeyValueCollection extension, WorkbinInfo workbin, ReasonInfo reason, java.lang.Integer notifyPropertyChanges)
          Creates instance of RequestWorkbinNotifications.
static RequestWorkbinNotifications create(WorkbinInfo workbin, ReasonInfo reason)
          Creates instance of RequestWorkbinNotifications.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getIdsOnlyInTakenOutNotification()
          If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client.
abstract  java.lang.Integer getNotifyPropertyChanges()
          Default value 0 (false).
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()
          [Optional] Tenant identifier of the agent.
abstract  WorkbinInfo getWorkbin()
           
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setIdsOnlyInTakenOutNotification(int idsOnlyInTakenOutNotification)
          If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client.
abstract  void setIdsOnlyInTakenOutNotification(java.lang.Integer idsOnlyInTakenOutNotification)
          If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client.
abstract  void setNotifyPropertyChanges(int notifyPropertyChanges)
          Default value 0 (false).
abstract  void setNotifyPropertyChanges(java.lang.Integer notifyPropertyChanges)
          Default value 0 (false).
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)
          [Optional] Tenant identifier of the agent.
abstract  void setTenantId(java.lang.Integer tenantId)
          [Optional] Tenant identifier of the agent.
abstract  void setWorkbin(WorkbinInfo workbin)
           
 
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 RequestWorkbinNotifications create()
Creates instance of RequestWorkbinNotifications with no parameters set.

Returns:
instance of RequestWorkbinNotifications

create

public static RequestWorkbinNotifications create(java.lang.Integer proxyClientId,
                                                 KeyValueCollection extension,
                                                 WorkbinInfo workbin,
                                                 ReasonInfo reason,
                                                 java.lang.Integer notifyPropertyChanges)
Creates instance of RequestWorkbinNotifications.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
workbin - Workbin
reason - Reason.
notifyPropertyChanges - If present and set to non-zero value, Interaction Server will notify the subscriber about property changes for interactions located in the workbin by means of EventPropertiesChanged. Default value 0 (false).
Returns:
instance of RequestWorkbinNotifications

create

public static RequestWorkbinNotifications create(WorkbinInfo workbin,
                                                 ReasonInfo reason)
Creates instance of RequestWorkbinNotifications.

Parameters:
workbin - Workbin
reason - Reason.
Returns:
instance of RequestWorkbinNotifications

getTenantId

public abstract java.lang.Integer getTenantId()
[Optional] Tenant identifier of the agent. Must be specified in the request from proxy. For agent application, the logged in agent tenant id is taken and if this attribute is specified and is not equal to agent's tenant id, the error is generated.


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
[Optional] Tenant identifier of the agent. Must be specified in the request from proxy. For agent application, the logged in agent tenant id is taken and if this attribute is specified and is not equal to agent's tenant id, the error is generated.


setTenantId

public abstract void setTenantId(int tenantId)
[Optional] Tenant identifier of the agent. Must be specified in the request from proxy. For agent application, the logged in agent tenant id is taken and if this attribute is specified and is not equal to agent's tenant id, the error is generated.


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.


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:


getWorkbin

public abstract WorkbinInfo getWorkbin()

setWorkbin

public abstract void setWorkbin(WorkbinInfo workbin)

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).


getNotifyPropertyChanges

public abstract java.lang.Integer getNotifyPropertyChanges()
Default value 0 (false). If present and set to non-zero value, Interaction Server will notify the subscriber about property changes for interactions located in the workbin by means of EventPropertiesChanged.


setNotifyPropertyChanges

public abstract void setNotifyPropertyChanges(java.lang.Integer notifyPropertyChanges)
Default value 0 (false). If present and set to non-zero value, Interaction Server will notify the subscriber about property changes for interactions located in the workbin by means of EventPropertiesChanged.


setNotifyPropertyChanges

public abstract void setNotifyPropertyChanges(int notifyPropertyChanges)
Default value 0 (false). If present and set to non-zero value, Interaction Server will notify the subscriber about property changes for interactions located in the workbin by means of EventPropertiesChanged.


getIdsOnlyInTakenOutNotification

public abstract java.lang.Integer getIdsOnlyInTakenOutNotification()
If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client. Default value is 0 (false).

Returns:
property value

setIdsOnlyInTakenOutNotification

public abstract void setIdsOnlyInTakenOutNotification(java.lang.Integer idsOnlyInTakenOutNotification)
If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client. Default value is 0 (false).

Parameters:
idsOnlyInTakenOutNotification - new value of the property

setIdsOnlyInTakenOutNotification

public abstract void setIdsOnlyInTakenOutNotification(int idsOnlyInTakenOutNotification)
If present and has value not equal to 0, Interaction Server would report interaction ids only for interactions moved out of the workbin in EventWorkbinContentChanged when distributing to the corresponding client. Default value is 0 (false).

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