jain.protocol.ss7.tcap.component
Class ErrorReqEvent

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

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

Fields inherited from class jain.protocol.ss7.tcap.ComponentReqEvent
dialogueId, dialogueIdPresent, invokeId, 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()
          Gets the link Id parameter of the ERROR request component.
 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()
          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 request Component.
 void setErrorType(int errorType)
          Sets the error type of this ERROR request Component.
 void setLinkId(int value)
          Sets the link Id parameter of the ERROR request component.
 void setParameters(Parameters params)
          Sets the Parameters' parameter of the ERROR request Component.
 java.lang.String toString()
          Returns a string representation of an instance of this class.
 
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.
Method Detail

isInvokeIdPresent

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

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 request 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 request
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 request component.
Parameters:
value - the link Id of the ERROR request

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

setParameters

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

getErrorType

public int getErrorType()
                 throws ParameterNotSetException
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:
ParameterNotSetException - this exception is thrown if this Mandatory parameter has not yet been set

setErrorType

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

getErrorCode

public byte[] getErrorCode()
                    throws ParameterNotSetException
Returns the error code of this ERROR request Component.
Returns:
the error code
Throws:
ParameterNotSetException - this exception is thrown if this Mandatory parameter has not yet been set

setErrorCode

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

getPrimitiveType

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

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


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems