jain.protocol.ss7.tcap.component
Class ErrorIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentIndEvent
              |
              +--jain.protocol.ss7.tcap.component.ErrorIndEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class ErrorIndEvent

extends ComponentIndEvent

An event representing a TCAP Error indication 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:

ComponentIndEvent, Serialized Form

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

m_dialogueId, m_dialogueIdPresent, m_invokeId, m_invokeIdPresent, m_lastComponent, m_lastComponentPresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

ErrorIndEvent(java.lang.Object source, int dialogueId, int errorType, byte[] errorCode, boolean lastComponent)
Constructs a new Error indication 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 .
int	getDialogueId() Gets the Dialogue Id parameter of this Error Indication, which is a reference identifier which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.
byte[]	getErrorCode() Returns the error code of this ERROR indication Component.
int	getErrorType() Returns the error type of this Error indication Component.
int	getInvokeId() Gets the Invoke Id parameter of this error indication.
int	getLinkId() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
Parameters	getParameters() Gets the 'Parameters' parameter of the ERROR indication Component.
int	getPrimitiveType() This method returns the type of this primitive.
boolean	isLinkIdPresent() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
boolean	isParametersPresent() Indicates if the Optional 'Parameters' field is present in this Event.
void	setErrorCode(byte[] errorCode) Sets the error code of this ERROR indication Component.
void	setErrorType(int errorType) Sets the error type of this ERROR indication 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 indication Component.
java.lang.String	toString() String representation of class ErrorIndEvent

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

isInvokeIdPresent, isLastComponent, setDialogueId, setInvokeId, setLastComponent, 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

ErrorIndEvent

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

Constructs a new Error indication 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

lastComponent - the Last Component Flag supplied to the constructor

Method Detail

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the ERROR indication Component.

Parameters:

params - The new Parameters value

setErrorType

public void setErrorType(int errorType)

Sets the error type of this ERROR indication 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 indication Component.

Parameters:

errorCode - The new Error Code value

See Also:

ComponentConstants

setLinkId

public void setLinkId(int value)

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

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException

Gets the Dialogue Id parameter of this Error Indication, which is a reference identifier which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.

Overrides:

getDialogueId in class ComponentIndEvent

Returns:

the Dialogue Id of this Error indication

Throws:

MandatoryParameterNotSetException - if this JAIN Mandatory parameter has not been set.

getInvokeId

public int getInvokeId()
                throws ParameterNotSetException

Gets the Invoke Id parameter of this error indication. Invoke Id identifies an operation invocation and its result. The mapping rules for the Invoke Identifier in an ERROR Component are:-
The Invoke Identifier is the Invoke Identifier as specified in the ITU recommendation and the Correlation Identifier as specified in the ANSI recommendation.

Overrides:

getInvokeId in class ComponentIndEvent

Returns:

the Invoke Id of the indication event

Throws:

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

isParametersPresent

public boolean isParametersPresent()

Indicates if the Optional '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 indication Component. Parameters contains any parameters that accompany an operation or that are provided in reply to an operation.

Returns:

the Parameters of the Error indication 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 indication 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 indication Component.

Returns:

the error code

Throws:

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

See Also:

ComponentConstants

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 ComponentIndEvent

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 ErrorIndEvent

Overrides:

toString in class ComponentIndEvent

Returns:

String provides description of class ErrorIndEvent