Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestFindInteractions
extends Message

This request represents a flexible interface for finding interactions by their properties.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestFindInteractions create()
          Creates instance of RequestFindInteractions with no parameters set.
static RequestFindInteractions create(java.lang.Integer tenantId)
          Creates instance of RequestFindInteractions with required parameters set.
static RequestFindInteractions create(java.lang.Integer tenantId, java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String condition, java.lang.String order, java.lang.Integer findMaxInteractions, java.lang.Integer findIdsOnly, ReasonInfo reason)
          Creates instance of RequestFindInteractions with all parameters set.
abstract  java.lang.String getCondition()
          Specifies conditions for the snapshot.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getFindIdsOnly()
           
abstract  java.lang.Integer getFindMaxInteractions()
           
abstract  java.lang.String getOrder()
          Specifies the order of interactions in the snapshot.
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 setCondition(java.lang.String condition)
          Specifies conditions for the snapshot.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setFindIdsOnly(int findIdsOnly)
           
abstract  void setFindIdsOnly(java.lang.Integer findIdsOnly)
           
abstract  void setFindMaxInteractions(int findMaxInteractions)
           
abstract  void setFindMaxInteractions(java.lang.Integer findMaxInteractions)
           
abstract  void setOrder(java.lang.String order)
          Specifies the order of interactions in the snapshot.
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 RequestFindInteractions create()
Creates instance of RequestFindInteractions with no parameters set.

Returns:
instance of RequestFindInteractions

create

public static RequestFindInteractions create(java.lang.Integer tenantId,
                                             java.lang.Integer proxyClientId,
                                             KeyValueCollection extension,
                                             java.lang.String condition,
                                             java.lang.String order,
                                             java.lang.Integer findMaxInteractions,
                                             java.lang.Integer findIdsOnly,
                                             ReasonInfo reason)
Creates instance of RequestFindInteractions with all parameters set.

Parameters:
tenantId - Tenant identifier of the party (dbid from the configuration).
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
condition - Specifies condition for the snapshot. Snapshot conditions are added to 'where' clause of the SQL 'select' statement generated by Interaction Server. It is possible to use Interaction Server database filed names, interaction property names, custom property names and functions provided by Interaction Server in condition. Property names are automatically translated to correspondent field names.
order - Specifies order of interactions in the snapshot. If not specified, default order is 'received_at, id'. Snapshot orders are added to 'order by' clause of the SQL 'select' statement generated by Interaction Server. It is possible to use interaction property names and custom property names in order. Property names are automatically translated to field names.
findMaxInteractions -
findIdsOnly -
reason - Reason.
Returns:
instance of RequestFindInteractions

create

public static RequestFindInteractions create(java.lang.Integer tenantId)
Creates instance of RequestFindInteractions with required parameters set.

Parameters:
tenantId - Tenant identifier of the party (dbid from the configuration).
Returns:
instance of RequestFindInteractions

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.


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


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:


getCondition

public abstract java.lang.String getCondition()
Specifies conditions for the snapshot. These conditions are added to the WHERE clause of the SQL SELECT statement that Interaction Server generates. Conditions can use Interaction Server database field names, interaction property names, custom property names, and translation functions. Interaction property names are converted to field names; for some explanation of the relations among these, see the chapter on interaction properties in the Multimedia 7.6 User's Guide.

Ordinarily, either this attribute or ViewId is present. If both are absent, the snapshot lists all interactions in the Interaction Server database.


setCondition

public abstract void setCondition(java.lang.String condition)
Specifies conditions for the snapshot. These conditions are added to the WHERE clause of the SQL SELECT statement that Interaction Server generates. Conditions can use Interaction Server database field names, interaction property names, custom property names, and translation functions. Interaction property names are converted to field names; for some explanation of the relations among these, see the chapter on interaction properties in the Multimedia 7.6 User's Guide.

Ordinarily, either this attribute or ViewId is present. If both are absent, the snapshot lists all interactions in the Interaction Server database.


getOrder

public abstract java.lang.String getOrder()
Specifies the order of interactions in the snapshot. This ordering specification is added to the ORDER BY clause of the SQL SELECT statement that Interaction Server generates. Ordering can use interaction property names and custom property names. Property names are converted to field names.

If no order is specified, the default order is first by ReceivedAt, then by InteractionId.


setOrder

public abstract void setOrder(java.lang.String order)
Specifies the order of interactions in the snapshot. This ordering specification is added to the ORDER BY clause of the SQL SELECT statement that Interaction Server generates. Ordering can use interaction property names and custom property names. Property names are converted to field names.

If no order is specified, the default order is first by ReceivedAt, then by InteractionId.


getFindMaxInteractions

public abstract java.lang.Integer getFindMaxInteractions()
Returns:
property value

setFindMaxInteractions

public abstract void setFindMaxInteractions(java.lang.Integer findMaxInteractions)
Parameters:
findMaxInteractions - new value of the property

setFindMaxInteractions

public abstract void setFindMaxInteractions(int findMaxInteractions)
Parameters:
findMaxInteractions - new value of the property

getFindIdsOnly

public abstract java.lang.Integer getFindIdsOnly()
Returns:
property value

setFindIdsOnly

public abstract void setFindIdsOnly(java.lang.Integer findIdsOnly)
Parameters:
findIdsOnly - new value of the property

setFindIdsOnly

public abstract void setFindIdsOnly(int findIdsOnly)
Parameters:
findIdsOnly - new value of the property

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.