jain.protocol.ss7.tcap.component
Class Parameters

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

All Implemented Interfaces:

java.io.Serializable

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.1

Author:

Sun Microsystems Inc.

See Also:

Serialized Form

Field Summary

static int	PARAMETERTYPE_SEQUENCE Indicates a parameter sequence, which holds a sequence of User Information elements.
static int	PARAMETERTYPE_SET Indicates a parameter set, which holds a set of User Information elements.
static int	PARAMETERTYPE_SINGLE Indicates a parameter 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() Deprecated. As of JAIN TCAP API v1.1. No replacement. The Parameter field is mandatory.
boolean	isParameterPresent() Deprecated. As of JAIN TCAP API v1.1. No replacement. The Parameter field is mandatory.
void	setParameter(byte[] parameter) Sets the 'Parameter values' field of the Component
void	setParameterIdentifier(int parameterIdentifier) Sets the 'Parameter Identifier' parameter of the Component
java.lang.String	toString() String representation of class Parameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETERTYPE_SINGLE

public static final int PARAMETERTYPE_SINGLE

Indicates a parameter 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 parameter 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 parameter 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 Parameter Identifier supplied to the constructor

parameter - the paramater supplied to the constructor

Method Detail

setParameterIdentifier

public void setParameterIdentifier(int parameterIdentifier)

Sets the 'Parameter Identifier' parameter of the Component

Parameters:

parameterIdentifier - one of the following:

• PARMETERTYPE_SINGLE
• PARMETERTYPE_SEQUENCE
• PARMETERTYPE_SET

setParameter

public void setParameter(byte[] parameter)

Sets the 'Parameter values' field of the Component

Parameters:

parameter - The new Parameter value

isParameterIdentifierPresent

public boolean isParameterIdentifierPresent()

Deprecated. As of JAIN TCAP API v1.1. No replacement. The Parameter field is mandatory.

getParameterIdentifier

public int getParameterIdentifier()
                           throws MandatoryParameterNotSetException

Returns the parameter Identifier of this Parameter. Update v1.1: Changed exception type of method from ParameterNotSetException to MandatoryParameterNotSetException.

Returns:

one of the following:

• PARMETERTYPE_SINGLE
• PARMETERTYPE_SEQUENCE
• PARMETERTYPE_SET

Throws:

MandatoryParameterNotSetException - this exception is thrown if this parameter has not been set

isParameterPresent

public boolean isParameterPresent()

Deprecated. As of JAIN TCAP API v1.1. No replacement. The Parameter field is mandatory.

getParameter

public byte[] getParameter()
                    throws MandatoryParameterNotSetException

Returns the supplied parameter values. Update v1.1: Changed exception type of method from ParameterNotSetException to MandatoryParameterNotSetException.

Returns:

the value of Parameters.

Throws:

MandatoryParameterNotSetException - this exception is thrown if this parameter has not been set

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters.

toString

public java.lang.String toString()

String representation of class Parameters

Overrides:

toString in class java.lang.Object

Returns:

String provides description of class Parameters