JAIN TCAP API
v1.1 - 5th Sept 2001

jain.protocol.ss7.tcap.component
Class Operation

java.lang.Object
  |
  +--jain.protocol.ss7.tcap.component.Operation
All Implemented Interfaces:
java.io.Serializable

public final class Operation
extends java.lang.Object
implements java.io.Serializable

This class represents the Operation parameter of a TCAP Component primitive. Operation identifies the action to be executed by the remote application.

Version:
1.1
Author:
Sun Microsystems Inc.
See Also:
Serialized Form

Field Summary
static int CALLERINTERACTIONSPECIFIER_INFORMATIONPROVIDED
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CALLERINTERACTIONSPECIFIER_INFORMATIONWAITING
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENTCOLLECTDIGIT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CHARGINGSPECIFIER_BILLCALL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CONNECTIONCONTROLSPECIFIER_CONNECT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CONNECTIONCONTROLSPECIFIER_DISCONNECT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CONNECTIONCONTROLSPECIFIER_TEMPORARYCONNECT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int CONNECTIONCONTROLSPECIFIER_TEMPORARYDISCONNECT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int MISCELLANEOUSSPECIFIER_DEQUEUECALL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int MISCELLANEOUSSPECIFIER_QUEUECALL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int NETWORKMANAGEMENTSPECIFIER_AUTOMATICCALLGAP
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONCONTROLSPECIFIER_CANCEL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_CALLERINTERACTION
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_CHARGING
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_CONNECTIONCONTROL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_MISCELLANEOUS
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_NETWORKMANAGEMENT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_OPERATIONCONTROL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_PARAMETER
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_PROCEDURAL
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_PROVIDEINSTRUCTION
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_REPORTEVENT
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONFAMILY_SENDNOTIFICATION
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int OPERATIONTYPE_GLOBAL
          Operation Type constants:
The following constants represent the allowable values for the operation type parameter depending on the protocol variant.
static int OPERATIONTYPE_LOCAL
          Indicates a Local(ITU) or Private(ANSI) operation type, this has an integer value of 1.
static int PARAMETERSPECIFIER_PROVIDEVALUE
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int PARAMETERSPECIFIER_SETVALUE
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int PROCEDURALSPECIFIER_REPORTASSISTTERMINATION
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific..
static int PROCEDURALSPECIFIER_TEMPORARYHANDOVER
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int PROVIDEINSTRUCTIONSPECIFIER_ASSIST
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int PROVIDEINSTRUCTIONSPECIFIER_START
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int REPORTEVENTSPECIFIER_VOICEMESSAGEAVAILABLE
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int REPORTEVENTSPECIFIER_VOICEMESSAGERETRIEVED
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
static int SENDNOTIFICATIONSPECIFIER_PARTYFREE
          Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.
 
Constructor Summary
Operation()
          Deprecated. - As of JAIN TCAP API v1.1, use constructor with mandatory Operation Type and Code.
Operation(int operationType, byte[] operationCode)
          Constructor for the Operation object, which accepts mandatory operation type and code parameters.
 
Method Summary
 void clearAllParameters()
          Clears all previously set parameters
 byte[] getOperationCode()
          Returns the Operation Code of the Operation.
 int getOperationFamily()
          Deprecated. As of Jain Tcap v1.1. Use getOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 int getOperationSpecifier()
          Deprecated. As of Jain Tcap v1.1. Use getOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 int getOperationType()
          Returns the Operation Type (Operation Code Identifier) of the Operation, which Identifies the Operation Code which follows it.
 byte[] getPrivateOperationData()
          Deprecated. As of Jain Tcap v1.1. Use getOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 boolean isOperationCodePresent()
          Deprecated. As of Jain Tcap v1.1. No replacement. Operation Code is mandatory
 boolean isOperationFamilyPresent()
          Deprecated. As of Jain Tcap v1.1. No replacement. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 boolean isOperationSpecifierPresent()
          Deprecated. As of Jain Tcap v1.1. No replacement. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 boolean isOperationTypePresent()
          Deprecated. As of Jain Tcap v1.1. No replacement. Operation Type is mandatory
 boolean isPrivateOperationDataPresent()
          Deprecated. As of Jain Tcap v1.1. No replacement. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 void setOperationCode(byte[] operationCode)
          Sets the Operation Code of the Operation.
 void setOperationFamily(int operationFamily)
          Deprecated. As of Jain Tcap v1.1. Use setOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 void setOperationSpecifier(int operationSpecifier)
          Deprecated. As of Jain Tcap v1.1. Use setOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 void setOperationType(int operationType)
          Sets the Operation Type (Operation Code Identifier) of the Operation, which when set will Identify the Operation Code to follow.
 void setPrivateOperationData(byte[] privateOperationData)
          Deprecated. As of Jain Tcap v1.1. Use setOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.
 java.lang.String toString()
          String representation of class jain.protocol.ss7.tcap.component.Operation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPERATIONTYPE_LOCAL

public static final int OPERATIONTYPE_LOCAL
Indicates a Local(ITU) or Private(ANSI) operation type, this has an integer value of 1.

OPERATIONTYPE_GLOBAL

public static final int OPERATIONTYPE_GLOBAL
Operation Type constants:
The following constants represent the allowable values for the operation type parameter depending on the protocol variant.

Indicates a Global(ITU) or National(ANSI) operation type, this has an integer value of 2.

OPERATIONFAMILY_CALLERINTERACTION

public static final int OPERATIONFAMILY_CALLERINTERACTION
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_CHARGING

public static final int OPERATIONFAMILY_CHARGING
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_PROVIDEINSTRUCTION

public static final int OPERATIONFAMILY_PROVIDEINSTRUCTION
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_CONNECTIONCONTROL

public static final int OPERATIONFAMILY_CONNECTIONCONTROL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_PARAMETER

public static final int OPERATIONFAMILY_PARAMETER
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_SENDNOTIFICATION

public static final int OPERATIONFAMILY_SENDNOTIFICATION
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_NETWORKMANAGEMENT

public static final int OPERATIONFAMILY_NETWORKMANAGEMENT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_PROCEDURAL

public static final int OPERATIONFAMILY_PROCEDURAL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_OPERATIONCONTROL

public static final int OPERATIONFAMILY_OPERATIONCONTROL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_REPORTEVENT

public static final int OPERATIONFAMILY_REPORTEVENT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


OPERATIONFAMILY_MISCELLANEOUS

public static final int OPERATIONFAMILY_MISCELLANEOUS
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


PARAMETERSPECIFIER_PROVIDEVALUE

public static final int PARAMETERSPECIFIER_PROVIDEVALUE
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


PARAMETERSPECIFIER_SETVALUE

public static final int PARAMETERSPECIFIER_SETVALUE
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CHARGINGSPECIFIER_BILLCALL

public static final int CHARGINGSPECIFIER_BILLCALL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


PROVIDEINSTRUCTIONSPECIFIER_START

public static final int PROVIDEINSTRUCTIONSPECIFIER_START
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


PROVIDEINSTRUCTIONSPECIFIER_ASSIST

public static final int PROVIDEINSTRUCTIONSPECIFIER_ASSIST
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CONNECTIONCONTROLSPECIFIER_CONNECT

public static final int CONNECTIONCONTROLSPECIFIER_CONNECT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CONNECTIONCONTROLSPECIFIER_TEMPORARYCONNECT

public static final int CONNECTIONCONTROLSPECIFIER_TEMPORARYCONNECT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CONNECTIONCONTROLSPECIFIER_DISCONNECT

public static final int CONNECTIONCONTROLSPECIFIER_DISCONNECT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CONNECTIONCONTROLSPECIFIER_TEMPORARYDISCONNECT

public static final int CONNECTIONCONTROLSPECIFIER_TEMPORARYDISCONNECT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CALLERINTERACTIONSPECIFIER_INFORMATIONPROVIDED

public static final int CALLERINTERACTIONSPECIFIER_INFORMATIONPROVIDED
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENTCOLLECTDIGIT

public static final int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENTCOLLECTDIGIT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CALLERINTERACTIONSPECIFIER_INFORMATIONWAITING

public static final int CALLERINTERACTIONSPECIFIER_INFORMATIONWAITING
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENT

public static final int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENT
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


SENDNOTIFICATIONSPECIFIER_PARTYFREE

public static final int SENDNOTIFICATIONSPECIFIER_PARTYFREE
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


NETWORKMANAGEMENTSPECIFIER_AUTOMATICCALLGAP

public static final int NETWORKMANAGEMENTSPECIFIER_AUTOMATICCALLGAP
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


PROCEDURALSPECIFIER_TEMPORARYHANDOVER

public static final int PROCEDURALSPECIFIER_TEMPORARYHANDOVER
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


PROCEDURALSPECIFIER_REPORTASSISTTERMINATION

public static final int PROCEDURALSPECIFIER_REPORTASSISTTERMINATION
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific..


OPERATIONCONTROLSPECIFIER_CANCEL

public static final int OPERATIONCONTROLSPECIFIER_CANCEL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


REPORTEVENTSPECIFIER_VOICEMESSAGEAVAILABLE

public static final int REPORTEVENTSPECIFIER_VOICEMESSAGEAVAILABLE
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


REPORTEVENTSPECIFIER_VOICEMESSAGERETRIEVED

public static final int REPORTEVENTSPECIFIER_VOICEMESSAGERETRIEVED
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


MISCELLANEOUSSPECIFIER_QUEUECALL

public static final int MISCELLANEOUSSPECIFIER_QUEUECALL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.


MISCELLANEOUSSPECIFIER_DEQUEUECALL

public static final int MISCELLANEOUSSPECIFIER_DEQUEUECALL
Deprecated. As of JAIN TCAP API v1.1. No replacement, application specific.

Constructor Detail

Operation

public Operation()
Deprecated. - As of JAIN TCAP API v1.1, use constructor with mandatory Operation Type and Code.


Operation

public Operation(int operationType,
                 byte[] operationCode)
Constructor for the Operation object, which accepts mandatory operation type and code parameters.
Since:
JAIN TCAP v1.1
Method Detail

setOperationType

public void setOperationType(int operationType)
Sets the Operation Type (Operation Code Identifier) of the Operation, which when set will Identify the Operation Code to follow.
Parameters:
operationType - one of the following:-
  • OPERATIONTYPE_GLOBAL (National for ANSI)
  • OPERATIONTYPE_LOCAL (Private for ANSI)

setOperationCode

public void setOperationCode(byte[] operationCode)
Sets the Operation Code of the Operation. The Operation Code will be used by an ANSI and ITU implementation of the JAIN TCAP API. The Operation Code within the ANSI Specification is decomposed into an Operation Family and Operation Specifier, but these are handled by the one field Operation Code within the JAIN TCAP API.
Parameters:
operationCode - The new OperationCode value
Since:
JAIN TCAP v1.1

getOperationType

public int getOperationType()
                     throws MandatoryParameterNotSetException
Returns the Operation Type (Operation Code Identifier) of the Operation, which Identifies the Operation Code which follows it.
Returns:
one of the following:
  • OPERATIONTYPE_GLOBAL (National for ANSI)
  • OPERATIONTYPE_LOCAL (Private for ANSI)
Throws:
MandatoryParameterNotSetException - thrown if this parameter has not been set.
Since:
JAIN TCAP v1.1

getOperationCode

public byte[] getOperationCode()
                        throws MandatoryParameterNotSetException
Returns the Operation Code of the Operation. The Operation Code will be used by an ITU implementation of the JAIN TCAP API.
Returns:
The operation code value
Throws:
MandatoryParameterNotSetException - thrown if this parameter has not been set.
Since:
JAIN TCAP v1.1

isOperationTypePresent

public boolean isOperationTypePresent()
Deprecated. As of Jain Tcap v1.1. No replacement. Operation Type is mandatory


isOperationCodePresent

public boolean isOperationCodePresent()
Deprecated. As of Jain Tcap v1.1. No replacement. Operation Code is mandatory


isOperationFamilyPresent

public boolean isOperationFamilyPresent()
Deprecated. As of Jain Tcap v1.1. No replacement. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


getOperationFamily

public int getOperationFamily()
                       throws ParameterNotSetException
Deprecated. As of Jain Tcap v1.1. Use getOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


isOperationSpecifierPresent

public boolean isOperationSpecifierPresent()
Deprecated. As of Jain Tcap v1.1. No replacement. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


getOperationSpecifier

public int getOperationSpecifier()
                          throws ParameterNotSetException
Deprecated. As of Jain Tcap v1.1. Use getOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


isPrivateOperationDataPresent

public boolean isPrivateOperationDataPresent()
Deprecated. As of Jain Tcap v1.1. No replacement. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


getPrivateOperationData

public byte[] getPrivateOperationData()
                               throws ParameterNotSetException
Deprecated. As of Jain Tcap v1.1. Use getOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


setOperationFamily

public void setOperationFamily(int operationFamily)
Deprecated. As of Jain Tcap v1.1. Use setOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


setOperationSpecifier

public void setOperationSpecifier(int operationSpecifier)
Deprecated. As of Jain Tcap v1.1. Use setOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


setPrivateOperationData

public void setPrivateOperationData(byte[] privateOperationData)
Deprecated. As of Jain Tcap v1.1. Use setOperationCode method. Breaking the Operation Code into family and specifier for an ANSI brings no value to the API.


clearAllParameters

public void clearAllParameters()
Clears all previously set parameters

toString

public java.lang.String toString()
String representation of class jain.protocol.ss7.tcap.component.Operation
Overrides:
toString in class java.lang.Object
Returns:
String provides description of class jain.protocol.ss7.tcap.component.Operation

JAIN TCAP API
v1.1 - 5th Sept 2001

Email comments to [email protected]