Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.party
Class RequestMakePredictiveCall

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.voice.protocol.tserver.requests.party.RequestMakePredictiveCall
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestMakePredictiveCall
extends Message

Makes a predictive call from the thisDN DN to the otherDN called party. A predictive call occurs before any agent-subscriber interaction is created. For example, if a fax machine answers the call, no agent connection occurs. The agent connection occurs only if there is an actual subscriber available on line.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestMakePredictiveCall create()
          Creates instance of RequestMakePredictiveCall with no parameters set.
static RequestMakePredictiveCall create(java.lang.String thisDN, java.lang.String otherDN, java.lang.Integer timeout)
          Creates instance of RequestMakePredictiveCall with required parameters set.
static RequestMakePredictiveCall create(java.lang.String thisDN, java.lang.String otherDN, java.lang.Integer timeout, KeyValueCollection userData, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestMakePredictiveCall with all parameters set.
abstract  KeyValueCollection getExtensions()
          An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
abstract  java.lang.String getOtherDN()
          The other main Directory Number (which your application did not register) involved in this request or event.
abstract  KeyValueCollection getReasons()
          Additional data intended to specify reasons for and results of actions taken by the user.
abstract  java.lang.Integer getReferenceID()
          Reference ID of the related request.
abstract  java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
abstract  java.lang.Integer getTimeout()
          Time interval, in seconds.
abstract  KeyValueCollection getUserData()
          Call-related user data.
abstract  void setExtensions(KeyValueCollection extensions)
          An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
abstract  void setOtherDN(java.lang.String otherDN)
          The other main Directory Number (which your application did not register) involved in this request or event.
abstract  void setReasons(KeyValueCollection reasons)
          Additional data intended to specify reasons for and results of actions taken by the user.
abstract  void setReferenceID(int referenceID)
          Reference ID of the related request.
abstract  void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
abstract  void setThisDN(java.lang.String thisDN)
          The Directory Number (which your application registered) involved in this request or event.
abstract  void setTimeout(int timeout)
          Time interval, in seconds.
abstract  void setTimeout(java.lang.Integer timeout)
          Time interval, in seconds.
abstract  void setUserData(KeyValueCollection userData)
          Call-related user data.
 
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 RequestMakePredictiveCall create()
Creates instance of RequestMakePredictiveCall with no parameters set.

Returns:
instance of RequestMakePredictiveCall

create

public static RequestMakePredictiveCall create(java.lang.String thisDN,
                                               java.lang.String otherDN,
                                               java.lang.Integer timeout,
                                               KeyValueCollection userData,
                                               KeyValueCollection reasons,
                                               KeyValueCollection extensions)
Creates instance of RequestMakePredictiveCall with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
otherDN - The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question.
timeout - Time interval, in seconds.
userData - Call-related user data.
reasons - Additional data intended to specify reasons for and results of actions taken by the user.
extensions - An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
Returns:
instance of RequestMakePredictiveCall

create

public static RequestMakePredictiveCall create(java.lang.String thisDN,
                                               java.lang.String otherDN,
                                               java.lang.Integer timeout)
Creates instance of RequestMakePredictiveCall with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
otherDN - The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question.
timeout - Time interval, in seconds.
Returns:
instance of RequestMakePredictiveCall

getReferenceID

public abstract java.lang.Integer getReferenceID()
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(int referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


getThisDN

public abstract java.lang.String getThisDN()
The Directory Number (which your application registered) involved in this request or event.


setThisDN

public abstract void setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event.


getOtherDN

public abstract java.lang.String getOtherDN()
The other main Directory Number (which your application did not register) involved in this request or event. For instance, the DN of the main party of the call.


setOtherDN

public abstract void setOtherDN(java.lang.String otherDN)
The other main Directory Number (which your application did not register) involved in this request or event. For instance, the DN of the main party of the call.


getTimeout

public abstract java.lang.Integer getTimeout()
Time interval, in seconds.

Returns:
property value

setTimeout

public abstract void setTimeout(java.lang.Integer timeout)
Time interval, in seconds.

Parameters:
timeout - new value of the property

setTimeout

public abstract void setTimeout(int timeout)
Time interval, in seconds.

Parameters:
timeout - new value of the property

getUserData

public abstract KeyValueCollection getUserData()
Call-related user data.

Returns:
property value

setUserData

public abstract void setUserData(KeyValueCollection userData)
Call-related user data.

Parameters:
userData - new value of the property

getReasons

public abstract KeyValueCollection getReasons()
Additional data intended to specify reasons for and results of actions taken by the user.

Returns:
property value

setReasons

public abstract void setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user.

Parameters:
reasons - new value of the property

getExtensions

public abstract KeyValueCollection getExtensions()
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.

Returns:
property value

setExtensions

public abstract void setExtensions(KeyValueCollection extensions)
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.

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