jain.protocol.ss7.tcap.component
Class Operation

java.lang.Object
  |
  +--jain.protocol.ss7.tcap.component.Operation

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.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Field Summary
static int CALLERINTERACTIONSPECIFIER_INFORMATIONPROVIDED
          Operation Specifier constants for Caller Interaction: The following constants represent the allowable values for the operation specifier parameter.

Indicates an Information Provided operation specifier for Caller Interaction, this constant has an integer value of 4.
static int CALLERINTERACTIONSPECIFIER_INFORMATIONWAITING
          Indicates an Information waiting operation specifier for Caller Interaction, this constant has an integer value of 3.
static int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENT
          Indicates a Play Announcement operation specifier for Caller Interaction, this constant has an integer value of 1.
static int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENTCOLLECTDIGIT
          Indicates a Play Announcement and Collect Digit operation specifier for Caller Interaction, this constant has an integer value of 2.
static int CHARGINGSPECIFIER_BILLCALL
          Operation Specifier constants for Charging:
The following constants represent the allowable values for the operation specifier parameter.

Indicates a Bill Call operation specifier for Charging, this constant has an integer value of 1.
static int CONNECTIONCONTROLSPECIFIER_CONNECT
          Operation Specifier constants for Connection Control: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Connect operation specifier for Connection Control, this constant has an integer value of 1.
static int CONNECTIONCONTROLSPECIFIER_DISCONNECT
          Indicates a Disconnect operation specifier for Connection Control, this constant has an integer value of 3.
static int CONNECTIONCONTROLSPECIFIER_TEMPORARYCONNECT
          Indicates a Tempory Connect operation specifier for Connection Control, this constant has an integer value of 2.
static int CONNECTIONCONTROLSPECIFIER_TEMPORARYDISCONNECT
          Indicates a Temporary Disconnect operation specifier for Connection Control, this constant has an integer value of 4.
static int MISCELLANEOUSSPECIFIER_DEQUEUECALL
          Operation Specifier constants for Miscellaneous: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Dequeue Call operation specifier for Miscellaneous, this constant has an integer value of 2.
static int MISCELLANEOUSSPECIFIER_QUEUECALL
          Indicates a Queue Call operation specifier for Miscellaneous, this constant has an integer value of 1.
static int NETWORKMANAGEMENTSPECIFIER_AUTOMATICCALLGAP
          Operation Specifier constants for Network Management: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Automatic Call Gap operation specifier for Network Management, this constant has an integer value of 1.
static int OPERATIONCONTROLSPECIFIER_CANCEL
          Operation Specifier constants for Operation Control: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Cancel operation specifier for Operation Control, this constant has an integer value of 1.
static int OPERATIONFAMILY_CALLERINTERACTION
          Operation family constants: The following constants represent the allowable values for the operation family parameter.

Indicates a Caller Interaction operation family, this has an integer value of 5.
static int OPERATIONFAMILY_CHARGING
          Indicates a Charging operation family, this has an integer value of 2.
static int OPERATIONFAMILY_CONNECTIONCONTROL
          Indicates a Connection Control operation family, this has an integer value of 4.
static int OPERATIONFAMILY_MISCELLANEOUS
          Indicates a Miscellaneous operation family, this has an integer value of 127, which matches its binary equivalent.
static int OPERATIONFAMILY_NETWORKMANAGEMENT
          Indicates a Network Management operation family, this has an integer value of 7.
static int OPERATIONFAMILY_OPERATIONCONTROL
          Indicates a Operation Control operation family, this has an integer value of 9.
static int OPERATIONFAMILY_PARAMETER
          Indicates a Parameter operation family, this has an integer value of 1.
static int OPERATIONFAMILY_PROCEDURAL
          Indicates a Procedural operation family, this has an integer value of 8.
static int OPERATIONFAMILY_PROVIDEINSTRUCTION
          Indicates a Provide Instruction operation family, this has an integer value of 3.
static int OPERATIONFAMILY_REPORTEVENT
          Indicates a Report Event operation family, this has an integer value of 10.
static int OPERATIONFAMILY_SENDNOTIFICATION
          Indicates a Send Notification operation family, this has an integer value of 6.
static 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.
static int OPERATIONTYPE_LOCAL
          Indicates a Local(ITU) or Private(ANSI) operation type, this has an integer value of 1.
static int PARAMETERSPECIFIER_PROVIDEVALUE
          Operation Specifier constants for Parameter: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Provide Value operation specifier for Parameter, this constant has an integer value of 1.
static int PARAMETERSPECIFIER_SETVALUE
          Indicates a Set Value operation specifier for Parameter, this constant has an integer value of 2.
static int PROCEDURALSPECIFIER_REPORTASSISTTERMINATION
          Operation Specifier constants for Procedural: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Report Assist Termination operation specifier for Procedural, this constant has an integer value of 2.
static int PROCEDURALSPECIFIER_TEMPORARYHANDOVER
          Indicates a Temporary Handover operation specifier for Procedural, this constant has an integer value of 1.
static int PROVIDEINSTRUCTIONSPECIFIER_ASSIST
          Operation Specifier constants for Provide Instruction: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Assist operation specifier for Provide Instruction, this constant has an integer value of 2.
static int PROVIDEINSTRUCTIONSPECIFIER_START
          Indicates a Start operation specifier for Provide Instruction, this constant has an integer value of 1.
static int REPORTEVENTSPECIFIER_VOICEMESSAGEAVAILABLE
          Indicates a Voice Message Available operation specifier for Report Event, this constant has an integer value of 1.
static int REPORTEVENTSPECIFIER_VOICEMESSAGERETRIEVED
          Operation Specifier constants for Report Events: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Voice Message Retrieved operation specifier for Report Event, this constant has an integer value of 2.
static int SENDNOTIFICATIONSPECIFIER_PARTYFREE
          Operation Specifier constants for Send Notification: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Party Free operation specifier for Send Notification, this constant has an integer value of 1.
 
Constructor Summary
Operation()
           
 
Method Summary
 void clearAllParameters()
          Clears all previously set parameters
 byte[] getOperationCode()
          Returns the Operation Code of the Operation.
 int getOperationFamily()
          Returns the Operation Family of the Operation.
 int getOperationSpecifier()
          Returns the Operation Specifier of the Operation.This is part of the ANSI specific breakdown of the Operation Code parameter.
 int getOperationType()
          Returns the Operation Type (Operation Code Identifier) of the Operation, which Identifies the Operation Code which follows it.
 byte[] getPrivateOperationData()
          Returns the private operation data of the Operation Component.
 boolean isOperationCodePresent()
          Indicates if the Operation Code field is present.
 boolean isOperationFamilyPresent()
          Indicates if the Operation Family field is present.
 boolean isOperationSpecifierPresent()
          Indicates if the Operation Specifier field is present.
 boolean isOperationTypePresent()
          Indicates if the Operation Type field is present.
 boolean isPrivateOperationDataPresent()
          Indicates if the Private Operation Data field is present.
 void setOperationCode(byte[] operationCode)
          Sets the Operation Code of the Operation.
 void setOperationFamily(int operationFamily)
          Sets the family of the Operation.
 void setOperationSpecifier(int operationSpecifier)
          Sets the Specifier of the Operation.
 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)
          Sets the Private Operation Data of the Operation component.
 java.lang.String toString()
           
 
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
Operation family constants: The following constants represent the allowable values for the operation family parameter.

Indicates a Caller Interaction operation family, this has an integer value of 5.

OPERATIONFAMILY_CHARGING

public static final int OPERATIONFAMILY_CHARGING
Indicates a Charging operation family, this has an integer value of 2.

OPERATIONFAMILY_PROVIDEINSTRUCTION

public static final int OPERATIONFAMILY_PROVIDEINSTRUCTION
Indicates a Provide Instruction operation family, this has an integer value of 3.

OPERATIONFAMILY_CONNECTIONCONTROL

public static final int OPERATIONFAMILY_CONNECTIONCONTROL
Indicates a Connection Control operation family, this has an integer value of 4.

OPERATIONFAMILY_PARAMETER

public static final int OPERATIONFAMILY_PARAMETER
Indicates a Parameter operation family, this has an integer value of 1.

OPERATIONFAMILY_SENDNOTIFICATION

public static final int OPERATIONFAMILY_SENDNOTIFICATION
Indicates a Send Notification operation family, this has an integer value of 6.

OPERATIONFAMILY_NETWORKMANAGEMENT

public static final int OPERATIONFAMILY_NETWORKMANAGEMENT
Indicates a Network Management operation family, this has an integer value of 7.

OPERATIONFAMILY_PROCEDURAL

public static final int OPERATIONFAMILY_PROCEDURAL
Indicates a Procedural operation family, this has an integer value of 8.

OPERATIONFAMILY_OPERATIONCONTROL

public static final int OPERATIONFAMILY_OPERATIONCONTROL
Indicates a Operation Control operation family, this has an integer value of 9.

OPERATIONFAMILY_REPORTEVENT

public static final int OPERATIONFAMILY_REPORTEVENT
Indicates a Report Event operation family, this has an integer value of 10.

OPERATIONFAMILY_MISCELLANEOUS

public static final int OPERATIONFAMILY_MISCELLANEOUS
Indicates a Miscellaneous operation family, this has an integer value of 127, which matches its binary equivalent.

PARAMETERSPECIFIER_PROVIDEVALUE

public static final int PARAMETERSPECIFIER_PROVIDEVALUE
Operation Specifier constants for Parameter: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Provide Value operation specifier for Parameter, this constant has an integer value of 1.

PARAMETERSPECIFIER_SETVALUE

public static final int PARAMETERSPECIFIER_SETVALUE
Indicates a Set Value operation specifier for Parameter, this constant has an integer value of 2.

CHARGINGSPECIFIER_BILLCALL

public static final int CHARGINGSPECIFIER_BILLCALL
Operation Specifier constants for Charging:
The following constants represent the allowable values for the operation specifier parameter.

Indicates a Bill Call operation specifier for Charging, this constant has an integer value of 1.

PROVIDEINSTRUCTIONSPECIFIER_START

public static final int PROVIDEINSTRUCTIONSPECIFIER_START
Indicates a Start operation specifier for Provide Instruction, this constant has an integer value of 1.

PROVIDEINSTRUCTIONSPECIFIER_ASSIST

public static final int PROVIDEINSTRUCTIONSPECIFIER_ASSIST
Operation Specifier constants for Provide Instruction: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Assist operation specifier for Provide Instruction, this constant has an integer value of 2.

CONNECTIONCONTROLSPECIFIER_CONNECT

public static final int CONNECTIONCONTROLSPECIFIER_CONNECT
Operation Specifier constants for Connection Control: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Connect operation specifier for Connection Control, this constant has an integer value of 1.

CONNECTIONCONTROLSPECIFIER_TEMPORARYCONNECT

public static final int CONNECTIONCONTROLSPECIFIER_TEMPORARYCONNECT
Indicates a Tempory Connect operation specifier for Connection Control, this constant has an integer value of 2.

CONNECTIONCONTROLSPECIFIER_DISCONNECT

public static final int CONNECTIONCONTROLSPECIFIER_DISCONNECT
Indicates a Disconnect operation specifier for Connection Control, this constant has an integer value of 3.

CONNECTIONCONTROLSPECIFIER_TEMPORARYDISCONNECT

public static final int CONNECTIONCONTROLSPECIFIER_TEMPORARYDISCONNECT
Indicates a Temporary Disconnect operation specifier for Connection Control, this constant has an integer value of 4.

CALLERINTERACTIONSPECIFIER_INFORMATIONPROVIDED

public static final int CALLERINTERACTIONSPECIFIER_INFORMATIONPROVIDED
Operation Specifier constants for Caller Interaction: The following constants represent the allowable values for the operation specifier parameter.

Indicates an Information Provided operation specifier for Caller Interaction, this constant has an integer value of 4.

CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENTCOLLECTDIGIT

public static final int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENTCOLLECTDIGIT
Indicates a Play Announcement and Collect Digit operation specifier for Caller Interaction, this constant has an integer value of 2.

CALLERINTERACTIONSPECIFIER_INFORMATIONWAITING

public static final int CALLERINTERACTIONSPECIFIER_INFORMATIONWAITING
Indicates an Information waiting operation specifier for Caller Interaction, this constant has an integer value of 3.

CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENT

public static final int CALLERINTERACTIONSPECIFIER_PLAYANNOUNCEMENT
Indicates a Play Announcement operation specifier for Caller Interaction, this constant has an integer value of 1.

SENDNOTIFICATIONSPECIFIER_PARTYFREE

public static final int SENDNOTIFICATIONSPECIFIER_PARTYFREE
Operation Specifier constants for Send Notification: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Party Free operation specifier for Send Notification, this constant has an integer value of 1.

NETWORKMANAGEMENTSPECIFIER_AUTOMATICCALLGAP

public static final int NETWORKMANAGEMENTSPECIFIER_AUTOMATICCALLGAP
Operation Specifier constants for Network Management: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Automatic Call Gap operation specifier for Network Management, this constant has an integer value of 1.

PROCEDURALSPECIFIER_TEMPORARYHANDOVER

public static final int PROCEDURALSPECIFIER_TEMPORARYHANDOVER
Indicates a Temporary Handover operation specifier for Procedural, this constant has an integer value of 1.

PROCEDURALSPECIFIER_REPORTASSISTTERMINATION

public static final int PROCEDURALSPECIFIER_REPORTASSISTTERMINATION
Operation Specifier constants for Procedural: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Report Assist Termination operation specifier for Procedural, this constant has an integer value of 2.

OPERATIONCONTROLSPECIFIER_CANCEL

public static final int OPERATIONCONTROLSPECIFIER_CANCEL
Operation Specifier constants for Operation Control: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Cancel operation specifier for Operation Control, this constant has an integer value of 1.

REPORTEVENTSPECIFIER_VOICEMESSAGEAVAILABLE

public static final int REPORTEVENTSPECIFIER_VOICEMESSAGEAVAILABLE
Indicates a Voice Message Available operation specifier for Report Event, this constant has an integer value of 1.

REPORTEVENTSPECIFIER_VOICEMESSAGERETRIEVED

public static final int REPORTEVENTSPECIFIER_VOICEMESSAGERETRIEVED
Operation Specifier constants for Report Events: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Voice Message Retrieved operation specifier for Report Event, this constant has an integer value of 2.

MISCELLANEOUSSPECIFIER_QUEUECALL

public static final int MISCELLANEOUSSPECIFIER_QUEUECALL
Indicates a Queue Call operation specifier for Miscellaneous, this constant has an integer value of 1.

MISCELLANEOUSSPECIFIER_DEQUEUECALL

public static final int MISCELLANEOUSSPECIFIER_DEQUEUECALL
Operation Specifier constants for Miscellaneous: The following constants represent the allowable values for the operation specifier parameter.

Indicates a Dequeue Call operation specifier for Miscellaneous, this constant has an integer value of 2.
Constructor Detail

Operation

public Operation()
Method Detail

isOperationTypePresent

public boolean isOperationTypePresent()
Indicates if the Operation Type field is present.
Returns:
true if Operation Type type has been set.

getOperationType

public int getOperationType()
                     throws ParameterNotSetException
Returns the Operation Type (Operation Code Identifier) of the Operation, which Identifies the Operation Code which follows it.
Returns:
one of the following:
  • OPERATIONTYPE_PRIVATE - Indicates a Local or Private operation
  • OPERATIONTYPE_NATIONAL - Indicates a Global or National operation

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 - the operation code of the Operation

isOperationCodePresent

public boolean isOperationCodePresent()
Indicates if the Operation Code field is present.
Returns:
true if Operation Code type has been set.

getOperationCode

public byte[] getOperationCode()
                        throws ParameterNotSetException
Returns the Operation Code of the Operation. The Operation Code will be used by an ITU implementation of the JAIN TCAP API. The Operation Code within the ANSI Specification is decomposed into an Operation Family and Operation Specifier which have also been decomposed within this class.

setOperationCode

public void setOperationCode(byte[] operationCode)
Sets the Operation Code of the Operation. The Operation Code will be used by an ITU implementation of the JAIN TCAP API. The Operation Code within the ANSI Specification is decomposed into an Operation Family and Operation Specifier which have also been decomposed within this class.
Parameters:
operationCode - the operation code of the Operation

isOperationFamilyPresent

public boolean isOperationFamilyPresent()
Indicates if the Operation Family field is present.
Returns:
true if Operation Family type has been set.

getOperationFamily

public int getOperationFamily()
                       throws ParameterNotSetException
Returns the Operation Family of the Operation. This is part of the ANSI specific breakdown of the Operation Code parameter. The second part of the Operation Code breakdown is the operation Specifier, were the Operation Specifier is dependenat on the Operation Family.
Returns:
one of the following Families:
  • PARAMETER
  • CHARGING
  • PROVIDE_INSTRUCTION
  • CONNECTION_CONTROL
  • CALLER_INTERACTION
  • SEND_NOTIFICATION
  • NETWORK_MANAGEMENT
  • PROCEDURAL
  • OPERATION_CONTROL
  • REPORT_EVENT
  • MISCELLANEOUS

setOperationFamily

public void setOperationFamily(int operationFamily)
Sets the family of the Operation. This is part of the ANSI specific breakdown of the Operation Code parameter. The second part of the Operation Code breakdown is the operation Specifier, were the Operation Specifier is dependenat on the Operation Family.
Parameters:
operationFamily - the Family of the Operation

isOperationSpecifierPresent

public boolean isOperationSpecifierPresent()
Indicates if the Operation Specifier field is present.
Returns:
true if Operation Specifier type has been set.

getOperationSpecifier

public int getOperationSpecifier()
                          throws ParameterNotSetException
Returns the Operation Specifier of the Operation.This is part of the ANSI specific breakdown of the Operation Code parameter. The second part of the Operation Code breakdown is the operation Family, were the Operation Specifier is dependenat on the Operation Family.
Returns:
the Operation Specifier of the Operation

setOperationSpecifier

public void setOperationSpecifier(int operationSpecifier)
Sets the Specifier of the Operation. This is part of the ANSI specific breakdown of the Operation Code parameter. The second part of the Operation Code breakdown is the operation Family, were the Operation Specifier is dependenat on the Operation Family.
Parameters:
operationSpecifier - the Operation Specifier of the Operation

isPrivateOperationDataPresent

public boolean isPrivateOperationDataPresent()
Indicates if the Private Operation Data field is present.
Returns:
true if Private Operation Data has been set.

getPrivateOperationData

public byte[] getPrivateOperationData()
                               throws ParameterNotSetException
Returns the private operation data of the Operation Component. The Private Operation Data will only be used by the ANSI protocol varient when the Opertaion is private, however the use of the parameter is dependent on the Length of the operation.
Returns:
the private operation data

setPrivateOperationData

public void setPrivateOperationData(byte[] privateOperationData)
Sets the Private Operation Data of the Operation component. The Private Operation Data will only be used by the ANSI protocol varient when the Opertaion is private, however the use of the parameter is dependent on the Length of the operation.
Parameters:
privateOperationData - the private operation data of the Operation

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems