Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.iscc
Class RequestTransactionMonitoring

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

public abstract class RequestTransactionMonitoring
extends Message

This feature allows T-Server clients to monitor ISCC transactions that occur during the call data transfer between T-Servers in a multi-site environment. In order to be able to monitor ISCC messaging, a T-Server client must subscribe to the ISCC Transaction Monitoring using this request. Once a subscription request is confirmed, a client will receive updates about all multi-site operations of this T-Server in EventTransactionStatus.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestTransactionMonitoring create()
          Creates instance of RequestTransactionMonitoring with no parameters set.
static RequestTransactionMonitoring create(SubscriptionOperationType subscriptionOperation)
          Creates instance of RequestTransactionMonitoring with required parameters set.
static RequestTransactionMonitoring create(SubscriptionOperationType subscriptionOperation, java.lang.String subscriptionID, KeyValueCollection extensions)
          Creates instance of RequestTransactionMonitoring 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.Integer getReferenceID()
          Reference ID of the related request.
abstract  java.lang.String getSubscriptionID()
           
abstract  SubscriptionOperationType getSubscriptionOperation()
           
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 setReferenceID(int referenceID)
          Reference ID of the related request.
abstract  void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
abstract  void setSubscriptionID(java.lang.String subscriptionID)
           
abstract  void setSubscriptionOperation(SubscriptionOperationType subscriptionOperation)
           
 
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 RequestTransactionMonitoring create()
Creates instance of RequestTransactionMonitoring with no parameters set.

Returns:
instance of RequestTransactionMonitoring

create

public static RequestTransactionMonitoring create(SubscriptionOperationType subscriptionOperation,
                                                  java.lang.String subscriptionID,
                                                  KeyValueCollection extensions)
Creates instance of RequestTransactionMonitoring with all parameters set.

Parameters:
subscriptionOperation -
subscriptionID -
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 RequestTransactionMonitoring

create

public static RequestTransactionMonitoring create(SubscriptionOperationType subscriptionOperation)
Creates instance of RequestTransactionMonitoring with required parameters set.

Parameters:
subscriptionOperation -
Returns:
instance of RequestTransactionMonitoring

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.


getSubscriptionOperation

public abstract SubscriptionOperationType getSubscriptionOperation()
Returns:
property value

setSubscriptionOperation

public abstract void setSubscriptionOperation(SubscriptionOperationType subscriptionOperation)
Parameters:
subscriptionOperation - new value of the property

getSubscriptionID

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

setSubscriptionID

public abstract void setSubscriptionID(java.lang.String subscriptionID)
Parameters:
subscriptionID - 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.