Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.special
Class RequestReserveAgentAndGetAccessNumber

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

public abstract class RequestReserveAgentAndGetAccessNumber
extends Message

Acts as if two requests (RequestReserveAgent, and RequestGetAccessNumber) were submitted consequently.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestReserveAgentAndGetAccessNumber create()
          Creates instance of RequestReserveAgentAndGetAccessNumber with no parameters set.
static RequestReserveAgentAndGetAccessNumber create(java.lang.String location)
          Creates instance of RequestReserveAgentAndGetAccessNumber with required parameters set.
static RequestReserveAgentAndGetAccessNumber create(java.lang.String location, java.lang.String thisDN, java.lang.String agentID, java.lang.String place, java.lang.String otherDN, java.lang.Integer timeout, java.lang.Integer priority, ConnectionId connID, XRouteType xRouteType, KeyValueCollection userData, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestReserveAgentAndGetAccessNumber with all parameters set.
abstract  java.lang.String getAgentID()
          The agent identifier specified by PBX or ACD.
abstract  ConnectionId getConnID()
          Connection identifier of the current call handled by the DN.
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 getLocation()
          Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
abstract  java.lang.String getOtherDN()
          The other main Directory Number (which your application did not register) involved in this request or event.
abstract  java.lang.String getPlace()
          The agent's place.
abstract  java.lang.Integer getPriority()
          Request priority.
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  XRouteType getXRouteType()
          The type of Routing between T-Servers to be applied to the telephony object in question.
abstract  void setAgentID(java.lang.String agentID)
          The agent identifier specified by PBX or ACD.
abstract  void setConnID(ConnectionId connID)
          Connection identifier of the current call handled by the DN.
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 setLocation(java.lang.String location)
          Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
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 setPlace(java.lang.String place)
          The agent's place.
abstract  void setPriority(int priority)
          Request priority.
abstract  void setPriority(java.lang.Integer priority)
          Request priority.
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.
abstract  void setXRouteType(XRouteType xRouteType)
          The type of Routing between T-Servers to be applied to the telephony object in question.
 
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 RequestReserveAgentAndGetAccessNumber create()
Creates instance of RequestReserveAgentAndGetAccessNumber with no parameters set.

Returns:
instance of RequestReserveAgentAndGetAccessNumber

create

public static RequestReserveAgentAndGetAccessNumber create(java.lang.String location,
                                                           java.lang.String thisDN,
                                                           java.lang.String agentID,
                                                           java.lang.String place,
                                                           java.lang.String otherDN,
                                                           java.lang.Integer timeout,
                                                           java.lang.Integer priority,
                                                           ConnectionId connID,
                                                           XRouteType xRouteType,
                                                           KeyValueCollection userData,
                                                           KeyValueCollection reasons,
                                                           KeyValueCollection extensions)
Creates instance of RequestReserveAgentAndGetAccessNumber with all parameters set.

Parameters:
location - Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
thisDN - DN of the controlling agent or Route Point.
agentID - The agent identifier specified by PBX or ACD.
place - The agent's place.
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.
priority - Request priority. Specify -1 to use default of 0, the lowest priority value.
connID - Connection identifier of the current call handled by the DN.
xRouteType - The type of Routing between T-Servers to be applied to the telephony object in question.
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 RequestReserveAgentAndGetAccessNumber

create

public static RequestReserveAgentAndGetAccessNumber create(java.lang.String location)
Creates instance of RequestReserveAgentAndGetAccessNumber with required parameters set.

Parameters:
location - Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
Returns:
instance of RequestReserveAgentAndGetAccessNumber

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.


getLocation

public abstract java.lang.String getLocation()
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Returns:
property value

setLocation

public abstract void setLocation(java.lang.String location)
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Parameters:
location - new value of the property

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.


getAgentID

public abstract java.lang.String getAgentID()
The agent identifier specified by PBX or ACD.

Returns:
property value

setAgentID

public abstract void setAgentID(java.lang.String agentID)
The agent identifier specified by PBX or ACD.

Parameters:
agentID - new value of the property

getPlace

public abstract java.lang.String getPlace()
The agent's place.

Returns:
property value

setPlace

public abstract void setPlace(java.lang.String place)
The agent's place.

Parameters:
place - new value of the property

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

getPriority

public abstract java.lang.Integer getPriority()
Request priority. Specify -1 to use default of 0, the lowest priority value.

Returns:
property value

setPriority

public abstract void setPriority(java.lang.Integer priority)
Request priority. Specify -1 to use default of 0, the lowest priority value.

Parameters:
priority - new value of the property

setPriority

public abstract void setPriority(int priority)
Request priority. Specify -1 to use default of 0, the lowest priority value.

Parameters:
priority - new value of the property

getConnID

public abstract ConnectionId getConnID()
Connection identifier of the current call handled by the DN.


setConnID

public abstract void setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN.


getXRouteType

public abstract XRouteType getXRouteType()
The type of Routing between T-Servers to be applied to the telephony object in question.

Returns:
property value

setXRouteType

public abstract void setXRouteType(XRouteType xRouteType)
The type of Routing between T-Servers to be applied to the telephony object in question.

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