|
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.voice.protocol.tserver.requests.special.RequestReserveAgent
public abstract class RequestReserveAgent
Allows a server application that is a client of T-Server to reserve a DN along with an Agent, a Place, or both, so that no other T-Server client can route calls to it during a specified reservation interval. At least one of the agent_dn, agent_id, or agent_place parameters must be present for a reservation to occur. If more than one is specified in the request, the reservation occurs on all specified entities. The reservation does not currently prevent the reserved objects from receiving direct calls or calls distributed from ACD Queues; agent reservation is intended as a way of synchronizing the operation of several clients. An attempt to reserve again an already-reserved Agent (that is, an Agent for whom a positive reservation confirmation is received) by the same server generates a successful response message and sets a new duration time only if option reject-subsequent-request is set to false. A duration time of 0 cancels the reservation. An attempt to cancel a non-existing reservation generates an error response. If several requests for conflicting Agents/Places/DNs are sent by the same server before a confirmation is received, all requests are queued and a reservation proceeds as if all requests have come from different servers. An attempt to reserve again with a different combination of Agent/Place/DN causes an error response.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestReserveAgent |
create()
Creates instance of RequestReserveAgent with no parameters set. |
static RequestReserveAgent |
create(java.lang.String thisDN,
java.lang.Integer priority)
Creates instance of RequestReserveAgent with required parameters set. |
static RequestReserveAgent |
create(java.lang.String thisDN,
java.lang.Integer priority,
java.lang.String agentID,
java.lang.String place,
java.lang.Integer timeout,
KeyValueCollection reasons,
KeyValueCollection extensions)
Creates instance of RequestReserveAgent with all parameters set. |
abstract java.lang.String |
getAgentID()
The agent identifier specified by PBX or ACD. |
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 |
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 void |
setAgentID(java.lang.String agentID)
The agent identifier specified by PBX or ACD. |
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 |
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. |
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 RequestReserveAgent create()
public static RequestReserveAgent create(java.lang.String thisDN, java.lang.Integer priority, java.lang.String agentID, java.lang.String place, java.lang.Integer timeout, KeyValueCollection reasons, KeyValueCollection extensions)
thisDN
- DN of the controlling agent or Route Point.priority
- Request priority. Specify -1 to use default of 0, the lowest priority value.agentID
- The agent identifier specified by PBX or ACD.place
- The agent's place.timeout
- Time interval, in seconds.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.
public static RequestReserveAgent create(java.lang.String thisDN, java.lang.Integer priority)
thisDN
- DN of the controlling agent or Route Point.priority
- Request priority. Specify -1 to use default of 0, the lowest priority value.
public abstract java.lang.Integer getReferenceID()
public abstract void setReferenceID(java.lang.Integer referenceID)
public abstract void setReferenceID(int referenceID)
public abstract java.lang.String getThisDN()
public abstract void setThisDN(java.lang.String thisDN)
public abstract java.lang.Integer getPriority()
public abstract void setPriority(java.lang.Integer priority)
priority
- new value of the propertypublic abstract void setPriority(int priority)
priority
- new value of the propertypublic abstract java.lang.String getAgentID()
public abstract void setAgentID(java.lang.String agentID)
agentID
- new value of the propertypublic abstract java.lang.String getPlace()
public abstract void setPlace(java.lang.String place)
place
- new value of the propertypublic abstract java.lang.Integer getTimeout()
public abstract void setTimeout(java.lang.Integer timeout)
timeout
- new value of the propertypublic abstract void setTimeout(int timeout)
timeout
- new value of the propertypublic abstract KeyValueCollection getReasons()
public abstract void setReasons(KeyValueCollection reasons)
reasons
- new value of the propertypublic abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
extensions
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |