|
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.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestFindOrCreatePhoneCall
public final class RequestFindOrCreatePhoneCall
This request finds an existing PhoneCall object. If no matching
record is found, then a new one is created.
Required parameters:
Name | Description |
---|---|
setTConnectionId(java.lang.String) |
The maximum length is 16 characters |
setOwnerId(java.lang.Integer) |
The unique owner ID. |
setTenantId(java.lang.Integer) |
Unique tenant ID. |
setTypeId(java.lang.String) |
Specifies the interaction type ID. This ID must exist in Configuration Server to be valid. The maximum length is 32 characters. |
setStatus(com.genesyslab.platform.contacts.protocol.contactserver.Statuses) |
The allowable integer values are: 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED). |
Name | Description |
---|---|
EventFindOrCreatePhoneCall |
This event returns a PhoneCall object. If no record was found matching the RequestFindOrCreatePhoneCall request criteria, then a new PhoneCall object is created before the event is returned. |
EventError |
Indicates that the request encountered an error. |
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage |
---|
REF_ID_KEY |
Constructor Summary | |
---|---|
RequestFindOrCreatePhoneCall()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestFindOrCreatePhoneCall |
create()
|
com.genesyslab.platform.commons.protocol.runtime.DataSupport |
createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
|
boolean |
equals(java.lang.Object obj)
|
KeyValueCollection |
getAllAttributes()
A series of key/value pairs containing user data. |
java.lang.Boolean |
getCanBeParent()
If no value is provided, UCS sets this attribute to TRUE. |
java.lang.String |
getCategoryId()
The maximum length is 16 characters. |
java.util.Map |
getCompounds()
|
java.lang.String |
getContactId()
The maximum length is 16 characters. |
java.lang.Integer |
getCreatorAppId()
If no value is provided, UCS sets this attribute to the UCS DBID. |
java.util.List |
getCustomPackagers()
|
java.lang.Integer |
getDuration()
An integer value that specifies the length of the call in seconds. |
java.util.Date |
getEndDate()
A string formatted to match the date pattern. |
java.lang.String |
getExternalId()
The maximum length is 256 characters. |
java.lang.Boolean |
getIsCategoryApproved()
Can be set to either TRUE or FALSE. |
java.lang.Boolean |
getIsSpam()
Can be set to either TRUE or FALSE. |
java.lang.String |
getLang()
The maximum length is 64 characters. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
java.lang.String |
getOutCome()
The maximum length is 100 characters. |
java.lang.Integer |
getOwnerId()
|
java.lang.String |
getParentId()
The maximum length is 16 characters. |
java.lang.String |
getPhoneCallId()
|
java.lang.String |
getPhoneNumber()
The maximum length is 30 characters. |
java.lang.String |
getQueueName()
The maximum length is 64 characters. |
java.util.Date |
getStartDate()
A string formatted to match the date pattern. |
Statuses |
getStatus()
The allowable integer values are: 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED). |
java.lang.String |
getStoppedReason()
The maximum length is 64 characters. |
java.lang.String |
getSubject()
The maximum length is 512 characters. |
java.lang.String |
getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the interaction should belong to. |
java.lang.String |
getSubtypeId()
Specifies the interaction subtype ID. |
java.lang.String |
getTConnectionId()
The maximum length is 16 characters. |
java.lang.Integer |
getTenantId()
|
java.lang.String |
getTheComment()
The default value is NULL. |
java.lang.String |
getThreadId()
The maximum length is 16 characters. |
java.lang.Integer |
getTimeshift()
The default value is NULL. |
java.lang.String |
getTypeId()
Specifies the interaction type ID. |
java.lang.String |
getWebSafeEmailStatus()
The maximum length is 32 characters. |
int |
hashCode()
|
void |
setAllAttributes(KeyValueCollection value)
A series of key/value pairs containing user data. |
void |
setCanBeParent(java.lang.Boolean value)
If no value is provided, UCS sets this attribute to TRUE. |
void |
setCategoryId(java.lang.String value)
The maximum length is 16 characters. |
void |
setContactId(java.lang.String value)
The maximum length is 16 characters. |
void |
setCreatorAppId(java.lang.Integer value)
If no value is provided, UCS sets this attribute to the UCS DBID. |
void |
setDuration(java.lang.Integer value)
An integer value that specifies the length of the call in seconds. |
void |
setEndDate(java.util.Date value)
A string formatted to match the date pattern. |
void |
setExternalId(java.lang.String value)
The maximum length is 256 characters. |
void |
setIsCategoryApproved(java.lang.Boolean value)
Can be set to either TRUE or FALSE. |
void |
setIsSpam(java.lang.Boolean value)
Can be set to either TRUE or FALSE. |
void |
setLang(java.lang.String value)
The maximum length is 64 characters. |
void |
setOutCome(java.lang.String value)
The maximum length is 100 characters. |
void |
setOwnerId(java.lang.Integer value)
|
void |
setParentId(java.lang.String value)
The maximum length is 16 characters. |
void |
setPhoneCallId(java.lang.String value)
|
void |
setPhoneNumber(java.lang.String value)
The maximum length is 30 characters. |
void |
setQueueName(java.lang.String value)
The maximum length is 64 characters. |
void |
setStartDate(java.util.Date value)
A string formatted to match the date pattern. |
void |
setStatus(Statuses value)
The allowable integer values are: 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED). |
void |
setStoppedReason(java.lang.String value)
The maximum length is 64 characters. |
void |
setSubject(java.lang.String value)
The maximum length is 512 characters. |
void |
setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the interaction should belong to. |
void |
setSubtypeId(java.lang.String value)
Specifies the interaction subtype ID. |
void |
setTConnectionId(java.lang.String value)
The maximum length is 16 characters. |
void |
setTenantId(java.lang.Integer value)
|
void |
setTheComment(java.lang.String value)
The default value is NULL. |
void |
setThreadId(java.lang.String value)
The maximum length is 16 characters. |
void |
setTimeshift(java.lang.Integer value)
The default value is NULL. |
void |
setTypeId(java.lang.String value)
Specifies the interaction type ID. |
void |
setWebSafeEmailStatus(java.lang.String value)
The maximum length is 32 characters. |
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage |
---|
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport |
---|
getProtocolDescription |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestFindOrCreatePhoneCall()
Method Detail |
---|
public static RequestFindOrCreatePhoneCall create()
public java.lang.String getPhoneCallId()
public void setPhoneCallId(java.lang.String value)
public java.lang.Integer getDuration()
public void setDuration(java.lang.Integer value)
public java.lang.String getOutCome()
public void setOutCome(java.lang.String value)
public java.lang.String getPhoneNumber()
public void setPhoneNumber(java.lang.String value)
public java.lang.String getTConnectionId()
public void setTConnectionId(java.lang.String value)
public java.lang.Integer getOwnerId()
public void setOwnerId(java.lang.Integer value)
public java.lang.Integer getTenantId()
public void setTenantId(java.lang.Integer value)
public java.lang.String getSubscriberId()
public void setSubscriberId(java.lang.String value)
public java.lang.Boolean getCanBeParent()
public void setCanBeParent(java.lang.Boolean value)
public java.lang.Integer getCreatorAppId()
public void setCreatorAppId(java.lang.Integer value)
public java.lang.String getTypeId()
public void setTypeId(java.lang.String value)
public java.util.Date getStartDate()
public void setStartDate(java.util.Date value)
public Statuses getStatus()
public void setStatus(Statuses value)
public java.lang.Integer getTimeshift()
public void setTimeshift(java.lang.Integer value)
public java.lang.String getCategoryId()
public void setCategoryId(java.lang.String value)
public java.lang.String getSubtypeId()
public void setSubtypeId(java.lang.String value)
public java.lang.String getExternalId()
public void setExternalId(java.lang.String value)
public java.lang.String getThreadId()
public void setThreadId(java.lang.String value)
public java.lang.String getSubject()
public void setSubject(java.lang.String value)
public java.lang.Boolean getIsCategoryApproved()
public void setIsCategoryApproved(java.lang.Boolean value)
public java.lang.String getStoppedReason()
public void setStoppedReason(java.lang.String value)
public java.lang.String getContactId()
public void setContactId(java.lang.String value)
public java.lang.String getParentId()
public void setParentId(java.lang.String value)
public java.lang.String getLang()
public void setLang(java.lang.String value)
public java.lang.String getQueueName()
public void setQueueName(java.lang.String value)
public java.lang.Boolean getIsSpam()
public void setIsSpam(java.lang.Boolean value)
public java.lang.String getWebSafeEmailStatus()
public void setWebSafeEmailStatus(java.lang.String value)
public java.lang.String getTheComment()
public void setTheComment(java.lang.String value)
public java.util.Date getEndDate()
public void setEndDate(java.util.Date value)
public KeyValueCollection getAllAttributes()
public void setAllAttributes(KeyValueCollection value)
public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |