Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestFindOrCreatePhoneCall

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
              extended by com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestFindOrCreatePhoneCall
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, ContactServerMessage, Printable, RequestorInfoSupport

public final class RequestFindOrCreatePhoneCall
extends AbstractMessage

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

Related Events:
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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Constructor Detail

RequestFindOrCreatePhoneCall

public RequestFindOrCreatePhoneCall()
Method Detail

create

public static RequestFindOrCreatePhoneCall create()

getPhoneCallId

public java.lang.String getPhoneCallId()

setPhoneCallId

public void setPhoneCallId(java.lang.String value)

getDuration

public java.lang.Integer getDuration()
An integer value that specifies the length of the call in seconds.


setDuration

public void setDuration(java.lang.Integer value)
An integer value that specifies the length of the call in seconds.


getOutCome

public java.lang.String getOutCome()
The maximum length is 100 characters.


setOutCome

public void setOutCome(java.lang.String value)
The maximum length is 100 characters.


getPhoneNumber

public java.lang.String getPhoneNumber()
The maximum length is 30 characters.


setPhoneNumber

public void setPhoneNumber(java.lang.String value)
The maximum length is 30 characters.


getTConnectionId

public java.lang.String getTConnectionId()
The maximum length is 16 characters.


setTConnectionId

public void setTConnectionId(java.lang.String value)
The maximum length is 16 characters.


getOwnerId

public java.lang.Integer getOwnerId()

setOwnerId

public void setOwnerId(java.lang.Integer value)

getTenantId

public java.lang.Integer getTenantId()

setTenantId

public void setTenantId(java.lang.Integer value)

getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the interaction should belong to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the interaction should belong to.


getCanBeParent

public java.lang.Boolean getCanBeParent()
If no value is provided, UCS sets this attribute to TRUE.


setCanBeParent

public void setCanBeParent(java.lang.Boolean value)
If no value is provided, UCS sets this attribute to TRUE.


getCreatorAppId

public java.lang.Integer getCreatorAppId()
If no value is provided, UCS sets this attribute to the UCS DBID.


setCreatorAppId

public void setCreatorAppId(java.lang.Integer value)
If no value is provided, UCS sets this attribute to the UCS DBID.


getTypeId

public java.lang.String getTypeId()
Specifies the interaction type ID. This ID must exist in Configuration Server to be valid. The maximum length is 32 characters.


setTypeId

public void setTypeId(java.lang.String value)
Specifies the interaction type ID. This ID must exist in Configuration Server to be valid. The maximum length is 32 characters.


getStartDate

public java.util.Date getStartDate()
A string formatted to match the date pattern. If no value is provided, UCS uses the current date. This value is stored in UTC format, and should be converted before use if local time is desired.


setStartDate

public void setStartDate(java.util.Date value)
A string formatted to match the date pattern. If no value is provided, UCS uses the current date. This value is stored in UTC format, and should be converted before use if local time is desired.


getStatus

public Statuses getStatus()
The allowable integer values are: 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED).


setStatus

public void setStatus(Statuses value)
The allowable integer values are: 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED).


getTimeshift

public java.lang.Integer getTimeshift()
The default value is NULL.


setTimeshift

public void setTimeshift(java.lang.Integer value)
The default value is NULL.


getCategoryId

public java.lang.String getCategoryId()
The maximum length is 16 characters. The default value is NULL.


setCategoryId

public void setCategoryId(java.lang.String value)
The maximum length is 16 characters. The default value is NULL.


getSubtypeId

public java.lang.String getSubtypeId()
Specifies the interaction subtype ID. This ID must exist in Configuration Server to be valid. The maximum length is 32 characters. The default value is NULL.


setSubtypeId

public void setSubtypeId(java.lang.String value)
Specifies the interaction subtype ID. This ID must exist in Configuration Server to be valid. The maximum length is 32 characters. The default value is NULL.


getExternalId

public java.lang.String getExternalId()
The maximum length is 256 characters. The default value is NULL.


setExternalId

public void setExternalId(java.lang.String value)
The maximum length is 256 characters. The default value is NULL.


getThreadId

public java.lang.String getThreadId()
The maximum length is 16 characters. The default value is NULL.


setThreadId

public void setThreadId(java.lang.String value)
The maximum length is 16 characters. The default value is NULL.


getSubject

public java.lang.String getSubject()
The maximum length is 512 characters. The default value is NULL.


setSubject

public void setSubject(java.lang.String value)
The maximum length is 512 characters. The default value is NULL.


getIsCategoryApproved

public java.lang.Boolean getIsCategoryApproved()
Can be set to either TRUE or FALSE. The default value is NULL.


setIsCategoryApproved

public void setIsCategoryApproved(java.lang.Boolean value)
Can be set to either TRUE or FALSE. The default value is NULL.


getStoppedReason

public java.lang.String getStoppedReason()
The maximum length is 64 characters. The default value is NULL.


setStoppedReason

public void setStoppedReason(java.lang.String value)
The maximum length is 64 characters. The default value is NULL.


getContactId

public java.lang.String getContactId()
The maximum length is 16 characters. The default value is NULL.


setContactId

public void setContactId(java.lang.String value)
The maximum length is 16 characters. The default value is NULL.


getParentId

public java.lang.String getParentId()
The maximum length is 16 characters. The default value is NULL.


setParentId

public void setParentId(java.lang.String value)
The maximum length is 16 characters. The default value is NULL.


getLang

public java.lang.String getLang()
The maximum length is 64 characters. The default value is NULL.


setLang

public void setLang(java.lang.String value)
The maximum length is 64 characters. The default value is NULL.


getQueueName

public java.lang.String getQueueName()
The maximum length is 64 characters. The default value is NULL.


setQueueName

public void setQueueName(java.lang.String value)
The maximum length is 64 characters. The default value is NULL.


getIsSpam

public java.lang.Boolean getIsSpam()
Can be set to either TRUE or FALSE. The default value is NULL.


setIsSpam

public void setIsSpam(java.lang.Boolean value)
Can be set to either TRUE or FALSE. The default value is NULL.


getWebSafeEmailStatus

public java.lang.String getWebSafeEmailStatus()
The maximum length is 32 characters. The default value is NULL.


setWebSafeEmailStatus

public void setWebSafeEmailStatus(java.lang.String value)
The maximum length is 32 characters. The default value is NULL.


getTheComment

public java.lang.String getTheComment()
The default value is NULL. Note: The maximum length of the comment field depends on what database you are using.


setTheComment

public void setTheComment(java.lang.String value)
The default value is NULL. Note: The maximum length of the comment field depends on what database you are using.


getEndDate

public java.util.Date getEndDate()
A string formatted to match the date pattern. The default value is NULL.


setEndDate

public void setEndDate(java.util.Date value)
A string formatted to match the date pattern. The default value is NULL.


getAllAttributes

public KeyValueCollection getAllAttributes()
A series of key/value pairs containing user data. The default value is NULL.


setAllAttributes

public void setAllAttributes(KeyValueCollection value)
A series of key/value pairs containing user data. The default value is NULL.


getMetaData

public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()

getCustomPackagers

public java.util.List getCustomPackagers()
Specified by:
getCustomPackagers in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
Overrides:
getCustomPackagers in class AbstractMessage

attributes

public java.util.Map attributes()

getCompounds

public java.util.Map getCompounds()

createClone

public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)

hashCode

public int hashCode()
Overrides:
hashCode in class DataObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class DataObject

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.