Platform SDK Java 8.5 API Reference

com.genesyslab.platform.routing.protocol.routingserver
Class OperationContext

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.routing.protocol.routingserver.OperationContext
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class OperationContext
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue

OperationContext, which imitates TEvent, is used in conjunction with methods that operate on interactions, and provides information about those interactions. Its contents can be changed when these methods are executed. Because of this, it can be present in both Requests and Events. For example, if a method executes a strategy, then it can update the user data of the associated call while the strategy is executing. OperationContext will reflect this update.


Constructor Summary
OperationContext()
           
 
Method Summary
static OperationContext create()
          Creates instance of OperationContext with no parameters set.
static OperationContext create(CallType callType, java.lang.String thisQueue, java.lang.String thisLocation, java.lang.String otherDN, java.lang.String aNI, java.lang.String dNIS, java.lang.String cED, java.lang.String mediaType, KeyValueCollection userData, KeyValueCollection extensions)
          Creates instance of OperationContext with all parameters set.
abstract  java.lang.String getANI()
           
abstract  CallType getCallType()
           
abstract  java.lang.String getCED()
           
abstract  java.lang.String getDNIS()
           
abstract  KeyValueCollection getExtensions()
           
abstract  java.lang.String getMediaType()
          The media type of a target.
abstract  java.lang.String getOtherDN()
           
abstract  java.lang.String getThisLocation()
           
abstract  java.lang.String getThisQueue()
           
abstract  KeyValueCollection getUserData()
           
abstract  void setANI(java.lang.String aNI)
           
abstract  void setCallType(CallType callType)
           
abstract  void setCED(java.lang.String cED)
           
abstract  void setDNIS(java.lang.String dNIS)
           
abstract  void setExtensions(KeyValueCollection extensions)
           
abstract  void setMediaType(java.lang.String mediaType)
          The media type of a target.
abstract  void setOtherDN(java.lang.String otherDN)
           
abstract  void setThisLocation(java.lang.String thisLocation)
           
abstract  void setThisQueue(java.lang.String thisQueue)
           
abstract  void setUserData(KeyValueCollection userData)
           
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue
getProtocolDescription
 
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
 

Constructor Detail

OperationContext

public OperationContext()
Method Detail

create

public static OperationContext create()
Creates instance of OperationContext with no parameters set.

Returns:
instance of OperationContext

create

public static OperationContext create(CallType callType,
                                      java.lang.String thisQueue,
                                      java.lang.String thisLocation,
                                      java.lang.String otherDN,
                                      java.lang.String aNI,
                                      java.lang.String dNIS,
                                      java.lang.String cED,
                                      java.lang.String mediaType,
                                      KeyValueCollection userData,
                                      KeyValueCollection extensions)
Creates instance of OperationContext with all parameters set.

Parameters:
callType -
thisQueue -
thisLocation -
otherDN -
aNI -
dNIS -
cED -
mediaType -
userData -
extensions -
Returns:
instance of OperationContext

getCallType

public abstract CallType getCallType()
Returns:
property value

setCallType

public abstract void setCallType(CallType callType)
Parameters:
callType - new value of the property

getThisQueue

public abstract java.lang.String getThisQueue()
Returns:
property value

setThisQueue

public abstract void setThisQueue(java.lang.String thisQueue)
Parameters:
thisQueue - new value of the property

getThisLocation

public abstract java.lang.String getThisLocation()
Returns:
property value

setThisLocation

public abstract void setThisLocation(java.lang.String thisLocation)
Parameters:
thisLocation - new value of the property

getOtherDN

public abstract java.lang.String getOtherDN()
Returns:
property value

setOtherDN

public abstract void setOtherDN(java.lang.String otherDN)
Parameters:
otherDN - new value of the property

getANI

public abstract java.lang.String getANI()
Returns:
property value

setANI

public abstract void setANI(java.lang.String aNI)
Parameters:
aNI - new value of the property

getDNIS

public abstract java.lang.String getDNIS()
Returns:
property value

setDNIS

public abstract void setDNIS(java.lang.String dNIS)
Parameters:
dNIS - new value of the property

getCED

public abstract java.lang.String getCED()
Returns:
property value

setCED

public abstract void setCED(java.lang.String cED)
Parameters:
cED - new value of the property

getMediaType

public abstract java.lang.String getMediaType()
The media type of a target.


setMediaType

public abstract void setMediaType(java.lang.String mediaType)
The media type of a target.


getUserData

public abstract KeyValueCollection getUserData()
Returns:
property value

setUserData

public abstract void setUserData(KeyValueCollection userData)
Parameters:
userData - new value of the property

getExtensions

public abstract KeyValueCollection getExtensions()
Returns:
property value

setExtensions

public abstract void setExtensions(KeyValueCollection extensions)
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.