jain.protocol.ss7.tcap.component
Class Parameters

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

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

Parameters is a parameter of a component. It is used to hold any parameters that accompany an operation or are provided in reply to an operation.

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Field Summary
static int PARAMETERTYPE_SEQUENCE
          Indicates a paramater sequence, which holds a sequence of User Information elements.
static int PARAMETERTYPE_SET
          Indicates a paramater set, which holds a set of User Information elements.
static int PARAMETERTYPE_SINGLE
          Indicates a paramater single, which holds only one User Information element.
 
Constructor Summary
Parameters(int parameterIdentifier, byte[] parameter)
          Constructs a new Parameters.
 
Method Summary
 void clearAllParameters()
          Clears all previously set parameters.
 byte[] getParameter()
          Returns the supplied parameter values.
 int getParameterIdentifier()
          Returns the parameter Identifier of this Parameter.
 boolean isParameterIdentifierPresent()
          Indicates if the Parameter Identifier field is present.
 boolean isParameterPresent()
          Indicates if the 'Parameter values' field is present.
 void setParameter(byte[] parameter)
          Sets the 'Parameter values' field of the PARAMETERS Class
 void setParameterIdentifier(int parameterIdentifier)
          Sets the 'Parameter Identifier' parameter of the PARAMETERS Component to one of the following: PARMETERTYPE_SINGLE PARMETERTYPE_SEQUENCE PARMETERTYPE_SET
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PARAMETERTYPE_SINGLE

public static final int PARAMETERTYPE_SINGLE
Indicates a paramater single, which holds only one User Information element. It has an integer value of 1.

PARAMETERTYPE_SEQUENCE

public static final int PARAMETERTYPE_SEQUENCE
Indicates a paramater sequence, which holds a sequence of User Information elements. It has an integer value of 2.

PARAMETERTYPE_SET

public static final int PARAMETERTYPE_SET
Indicates a paramater set, which holds a set of User Information elements. It has an integer value of 3.
Constructor Detail

Parameters

public Parameters(int parameterIdentifier,
                  byte[] parameter)
Constructs a new Parameters.
Parameters:
parameterIdentifier - the type of parameter, this may be either PARAMETERTYPE_SEQUENCE or PARAMETERTYPE_SET
parameter - the parameter data.
Method Detail

isParameterIdentifierPresent

public boolean isParameterIdentifierPresent()
Indicates if the Parameter Identifier field is present.
Returns:
true if the Parameter Identifier field has been set.

getParameterIdentifier

public int getParameterIdentifier()
                           throws ParameterNotSetException
Returns the parameter Identifier of this Parameter.
Returns:
either PARMETERTYPE_SINGLE, PARAMETERTYPE_SEQUENCE or PARAMETERTYPE_SET
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setParameterIdentifier

public void setParameterIdentifier(int parameterIdentifier)
Sets the 'Parameter Identifier' parameter of the PARAMETERS Component to one of the following:

isParameterPresent

public boolean isParameterPresent()
Indicates if the 'Parameter values' field is present.
Returns:
true if the 'Parameter values' field has been set.

getParameter

public byte[] getParameter()
                    throws ParameterNotSetException
Returns the supplied parameter values.
Returns:
the value of Parameters.
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setParameter

public void setParameter(byte[] parameter)
Sets the 'Parameter values' field of the PARAMETERS Class
Parameters:
para - the parameters in a byte array.

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters.

toString

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


28 June 2000
If you have any comments or queries, please mail them to JainTcapApiFeedback@AePONA.Com

Copyright - 2000 Sun Microsystems