Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestSetCallInfo
extends Message

Changes the call attributes. Warning: Improper use of this function may result in unpredictable behavior on the part of T-Server and the Genesys Framework. If you have any doubt on how to use it, please consult with Genesys.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSetCallInfo create()
          Creates instance of RequestSetCallInfo with no parameters set.
static RequestSetCallInfo create(ConnectionId connID, ConnectionId newConnID, SetOpType setOperation, java.lang.String thisDN)
          Creates instance of RequestSetCallInfo with required parameters set.
static RequestSetCallInfo create(ConnectionId connID, ConnectionId newConnID, SetOpType setOperation, java.lang.String thisDN, java.lang.String otherDN)
          Creates instance of RequestSetCallInfo with all parameters set.
abstract  ConnectionId getConnID()
          Connection identifier of the current call handled by the DN.
abstract  ConnectionId getNewConnID()
          A new connection identifier that is requested to be assigned to the call in question.
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.Integer getReferenceID()
          Reference ID of the related request.
abstract  SetOpType getSetOperation()
          Type of the action that must be performed with attributes of the call specified by conn_id.
abstract  java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
abstract  void setConnID(ConnectionId connID)
          Connection identifier of the current call handled by the DN.
abstract  void setNewConnID(ConnectionId newConnID)
          A new connection identifier that is requested to be assigned to the call in question.
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 setReferenceID(int referenceID)
          Reference ID of the related request.
abstract  void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
abstract  void setSetOperation(SetOpType setOperation)
          Type of the action that must be performed with attributes of the call specified by conn_id.
abstract  void setThisDN(java.lang.String thisDN)
          The Directory Number (which your application registered) involved in this request or event.
 
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 RequestSetCallInfo create()
Creates instance of RequestSetCallInfo with no parameters set.

Returns:
instance of RequestSetCallInfo

create

public static RequestSetCallInfo create(ConnectionId connID,
                                        ConnectionId newConnID,
                                        SetOpType setOperation,
                                        java.lang.String thisDN,
                                        java.lang.String otherDN)
Creates instance of RequestSetCallInfo with all parameters set.

Parameters:
connID - Connection identifier of the current call handled by the DN.
newConnID - A new connection identifier that is requested to be assigned to the call in question.
setOperation - Type of the action that must be performed with attributes of the call specified by conn_id.
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.
Returns:
instance of RequestSetCallInfo

create

public static RequestSetCallInfo create(ConnectionId connID,
                                        ConnectionId newConnID,
                                        SetOpType setOperation,
                                        java.lang.String thisDN)
Creates instance of RequestSetCallInfo with required parameters set.

Parameters:
connID - Connection identifier of the current call handled by the DN.
newConnID - A new connection identifier that is requested to be assigned to the call in question.
setOperation - Type of the action that must be performed with attributes of the call specified by conn_id.
thisDN - DN of the controlling agent or Route Point.
Returns:
instance of RequestSetCallInfo

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.


getNewConnID

public abstract ConnectionId getNewConnID()
A new connection identifier that is requested to be assigned to the call in question.

Returns:
property value

setNewConnID

public abstract void setNewConnID(ConnectionId newConnID)
A new connection identifier that is requested to be assigned to the call in question.

Parameters:
newConnID - new value of the property

getSetOperation

public abstract SetOpType getSetOperation()
Type of the action that must be performed with attributes of the call specified by conn_id.

Returns:
property value

setSetOperation

public abstract void setSetOperation(SetOpType setOperation)
Type of the action that must be performed with attributes of the call specified by conn_id.

Parameters:
setOperation - new value of the property

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.


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.