|
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.requests.interactionmanagement.RequestFindInteractions
public abstract class RequestFindInteractions
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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.
public static RequestFindInteractions create(java.lang.Integer tenantId)
tenantId
- Tenant identifier of the party (dbid from the configuration).
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 getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public 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 getCondition()
public abstract void setCondition(java.lang.String condition)
public abstract java.lang.String getOrder()
public abstract void setOrder(java.lang.String order)
public abstract java.lang.Integer getFindMaxInteractions()
public abstract void setFindMaxInteractions(java.lang.Integer findMaxInteractions)
findMaxInteractions
- new value of the propertypublic abstract void setFindMaxInteractions(int findMaxInteractions)
findMaxInteractions
- new value of the propertypublic abstract java.lang.Integer getFindIdsOnly()
public abstract void setFindIdsOnly(java.lang.Integer findIdsOnly)
findIdsOnly
- new value of the propertypublic abstract void setFindIdsOnly(int findIdsOnly)
findIdsOnly
- new value of the propertypublic 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 |