jain.protocol.ss7.tcap.component
Class ErrorIndEvent

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

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

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 that is used to associate all components within a 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()
          Gets the link Id parameter of the ERROR indication component.
 Parameters getParameters()
          Gets the 'Parameters' parameter of the ERROR indication Component.
 int getPrimitiveType()
          This method returns the type of this primitive.
 boolean isLinkIdPresent()
          Indicates if the link Id parameter is present in this Event.
 boolean isParametersPresent()
          Indicates if the '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)
          Sets the link Id parameter of the ERROR indication component.
 void setParameters(Parameters params)
          Sets the Parameters' parameter of the ERROR indication Component.
 java.lang.String toString()
          Returns a string representation of an instance of this class.
 
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
equals, 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.
Method Detail

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException
Gets the Dialogue Id parameter of this Error Indication, which is a reference identifier that is used to associate all components within a transaction.
Returns:
the Dialogue Id of this Error indication
Throws:
MandatoryParameterNotSetException - if this JAIN Mandatory parameter has not been set.
Overrides:
getDialogueId in class ComponentIndEvent

getInvokeId

public int getInvokeId()
                throws ParameterNotSetException
Gets the Invoke Id parameter of this error indication. Invoke Id identifies the an operation invocation and its result.
Returns:
the Invoke Id of the indication event
Throws:
ParameterNotSetException - this exception is thrown if this is a JAIN Optional parameter has not been set
Overrides:
getInvokeId in class ComponentIndEvent

isLinkIdPresent

public boolean isLinkIdPresent()
Indicates if the link Id parameter is present in this Event.
Returns:
true if link Id has been set.

getLinkId

public int getLinkId()
              throws ParameterNotSetException
Gets the link Id parameter of the ERROR indication component. The link Id parameter links an operation invocation to a previous operation invocation by the remote TCAP application.
Returns:
the link Id of the ERROR indication
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setLinkId

public void setLinkId(int value)
Sets the link Id parameter of the ERROR indication component.
Parameters:
value - the link Id of the ERROR indication

isParametersPresent

public boolean isParametersPresent()
Indicates if the 'Parameters' field is present in this Event.
Returns:
true if 'Parameters' has been set.

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 yet been set

setParameters

public void setParameters(Parameters params)
Sets the Parameters' parameter of the ERROR indication Component.
Parameters:
params - the Parameters of the ERROR indication Component.

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 yet been set

setErrorType

public void setErrorType(int errorType)
Sets the error type of this ERROR indication Component.
Parameters:
errorType - the type of error, this may be either ERROR_LOCAL or ERROR_GLOBAL.

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 yet been set

setErrorCode

public void setErrorCode(byte[] errorCode)
Sets the error code of this ERROR indication Component.
Parameters:
errorCode - the Error Code

getPrimitiveType

public int getPrimitiveType()
This method returns the type of this primitive.
Overrides:
getPrimitiveType in class ComponentIndEvent

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters .

toString

public java.lang.String toString()
Returns a string representation of an instance of this class.
Overrides:
toString in class java.util.EventObject


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

Copyright - 2000 Sun Microsystems