jain.protocol.ss7.tcap.component
Class ErrorReqEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentReqEvent
              |
              +--jain.protocol.ss7.tcap.component.ErrorReqEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class ErrorReqEvent

extends ComponentReqEvent

An event representing a TCAP Error request component primitive. The mandatory parameters of this primitive are supplied to the constructor. Optional parameters may then be set using the set methods.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

ComponentReqEvent, Serialized Form

Fields inherited from class jain.protocol.ss7.tcap.ComponentReqEvent

m_dialogueId, m_dialogueIdPresent, m_invokeId, m_invokeIdPresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

ErrorReqEvent(java.lang.Object source, int dialogueId, int errorType, byte[] errorCode)
Constructs a new Error request Event, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.

Method Summary

void	clearAllParameters() Clears all previously set parameters .
byte[]	getErrorCode() Returns the error code of this ERROR request Component.
int	getErrorType() Returns the error type of this Error Request Component.
int	getLinkId() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
Parameters	getParameters() Gets the Parameters' parameter of the ERROR request Component.
int	getPrimitiveType() This method returns the type of this primitive.
boolean	isInvokeIdPresent() Indicates if the Invoke Id is present in this Event.
boolean	isLinkIdPresent() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
boolean	isParametersPresent() Indicates if the 'Parameters' field is present in this Event.
void	setErrorCode(byte[] errorCode) Sets the error code of this Error Request Component.
void	setErrorType(int errorType) Sets the error type of this Error Request Component.
void	setLinkId(int value) Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
void	setParameters(Parameters params) Sets the Parameters' parameter of the Error Request Component.
java.lang.String	toString() String representation of class ErrorReqEvent

Methods inherited from class jain.protocol.ss7.tcap.ComponentReqEvent

getDialogueId, getInvokeId, setDialogueId, setInvokeId, setSource

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorReqEvent

public ErrorReqEvent(java.lang.Object source,
                     int dialogueId,
                     int errorType,
                     byte[] errorCode)

Constructs a new Error request Event, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.

Parameters:

source - the Event Source supplied to the constructor

dialogueId - the Dialogue Identifier supplied to the constructor

errorType - the Error Type supplied to the constructor

errorCode - the Error Code supplied to the constructor

Method Detail

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the Error Request Component.

Parameters:

params - The new Parameters value

setErrorType

public void setErrorType(int errorType)

Sets the error type of this Error Request Component.

Parameters:

errorType - one of the following:

• ERROR_LOCAL - indicates a local or private error
• ERROR_GLOBAL - indicates a global or national error

See Also:

ComponentConstants

setErrorCode

public void setErrorCode(byte[] errorCode)

Sets the error code of this Error Request Component.

Parameters:

errorCode - The new Error Code value

setLinkId

public void setLinkId(int value)

Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.

isInvokeIdPresent

public boolean isInvokeIdPresent()

Indicates if the Invoke Id is present in this Event.

Returns:

true if Invoke Id has been set, false otherwise.

isParametersPresent

public boolean isParametersPresent()

Indicates if the 'Parameters' field is present in this Event.

Returns:

true if 'Parameters' has been set, false otherwise.

getParameters

public Parameters getParameters()
                         throws ParameterNotSetException

Gets the Parameters' parameter of the ERROR request Component. Parameters contains any parameters that accompany an operation or that are provided in reply to an operation.

Returns:

the Parameters of the Error Request Component

Throws:

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

getErrorType

public int getErrorType()
                 throws MandatoryParameterNotSetException

Returns the error type of this Error Request Component.

Returns:

one of the following:

• ERROR_LOCAL - indicates a local or private error
• ERROR_GLOBAL - indicates a global or national error

Throws:

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

getErrorCode

public byte[] getErrorCode()
                    throws MandatoryParameterNotSetException

Returns the error code of this ERROR request Component.

Returns:

the error code

Throws:

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

isLinkIdPresent

public boolean isLinkIdPresent()

Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.

getLinkId

public int getLinkId()
              throws ParameterNotSetException

Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class ComponentReqEvent

Returns:

The Primitive Type of this event

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters .

toString

public java.lang.String toString()

String representation of class ErrorReqEvent

Overrides:

toString in class ComponentReqEvent

Returns:

String provides description of class ErrorReqEvent