jain.protocol.ss7.tcap.component
Class RejectIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class RejectIndEvent

extends ComponentIndEvent

An event representing a TCAP Reject 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

RejectIndEvent(java.lang.Object source, int dialogueId, int problemType, int problem, boolean lastComponent)
Constructs a new Reject 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 Reject Indication, which is a reference identifier which identifies a specific dialogue or transaction and all associated components within that dialogue or transaction.
int	getInvokeId() Gets the Invoke Id parameter of this Reject indication.
int	getLinkId() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
Parameters	getParameters() Gets the Parameters' parameter of the Reject indication Component.
int	getPrimitiveType() This method returns the type of this primitive.
int	getProblem() Returns the problem details of this Reject indication Component.
int	getProblemType() Returns the problem type of this Reject request Component.
int	getRejectType() Indicates the type of this Reject 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.
boolean	isRejectTypePresent() Indicates if the Reject Type flag is present in this Event.
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 Reject indication Component.
void	setProblem(int problem) Sets the problem details of this Reject indication Component.
void	setProblemType(int problemType) Sets the problem type of this Reject request Component.
void	setRejectType(int rejectType) Sets the type of this Reject as a Local, Remote or User Reject.
java.lang.String	toString() String representation of class RejectIndEvent

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

RejectIndEvent

public RejectIndEvent(java.lang.Object source,
                      int dialogueId,
                      int problemType,
                      int problem,
                      boolean lastComponent)

Constructs a new Reject 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

problemType - the Problem Type supplied to the constructor

problem - the Problem supplied to the constructor

lastComponent - the Last Component flag supplied to the constructor

Method Detail

setRejectType

public void setRejectType(int rejectType)

Sets the type of this Reject as a Local, Remote or User Reject. The Reject type is defaulted to a Local Reject.

Parameters:

rejectType - one of the following:

• REJECT_TYPE_USER
• REJECT_TYPE_REMOTE
• REJECT_TYPE_LOCAL

See Also:

ComponentConstants

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the Reject indication Component.

Parameters:

params - The new Parameters value

setProblemType

public void setProblemType(int problemType)

Sets the problem type of this Reject request Component.

Parameters:

problemType - The new ProblemType value, one of the following:

• PROBLEM_TYPE_GENERAL - a problem that does not relate to any specific component type.
• PROBLEM_TYPE_INVOKE - a problem that relates only to the invoke component type.
• PROBLEM_TYPE_RETURN_RESULT - a problem that relates to the return result component type.
• PROBLEM_TYPE_RETURN_ERROR - a problem that relates only to the return error component.
• PROBLEM_TYPE_DIALOGUE - a problem specific to a Dialogue primitive.

See Also:

ComponentConstants

setProblem

public void setProblem(int problem)

Sets the problem details of this Reject indication Component.

Parameters:

problem - One of the following problem codes, grouped by Problem type:

• PROBLEM_TYPE_GENERAL
  1. PROBLEM_CODE_BADLY_STRUCTURED_COMPONENT
  2. PROBLEM_CODE_MISTYPED_COMPONENT
  3. PROBLEM_CODE_UNRECOGNISED_COMPONENT
• PROBLEM_TYPE_INVOKE
  1. PROBLEM_CODE_DUPLICATE_INVOKE_ID
  2. PROBLEM_CODE_INITIATING_RELEASE
  3. PROBLEM_CODE_LINKED_RESPONSE_UNEXPECTED
  4. PROBLEM_CODE_MISTYPED_PARAMETER
  5. PROBLEM_CODE_RESOURCE_LIMITATION
  6. PROBLEM_CODE_UNEXPECTED_LINKED_OPERATION
  7. PROBLEM_CODE_UNRECOGNIZED_INVOKE_ID
  8. PROBLEM_CODE_UNRECOGNIZED_LINKED_ID
  9. PROBLEM_CODE_UNRECOGNIZED_OPERATION
• PROBLEM_TYPE_RETURN_RESULT
  1. PROBLEM_CODE_MISTYPED_PARAMETER
  2. PROBLEM_CODE_RETURN_RESULT_UNEXPECTED
  3. PROBLEM_CODE_UNRECOGNIZED_INVOKE_ID
• PROBLEM_TYPE_RETURN_ERROR
  1. PROBLEM_CODE_MISTYPED_PARAMETER
  2. PROBLEM_CODE_RETURN_ERROR_UNEXPECTED
  3. PROBLEM_CODE_UNRECOGNIZED_ERROR
  4. PROBLEM_CODE_UNRECOGNIZED_INVOKE_ID
• PROBLEM_TYPE_DIALOGUE
  1. PROBLEM_CODE_BADLY_STRUCTURED_DIALOGUE
  2. PROBLEM_CODE_INCORRECT_DIALOGUE
  3. PROBLEM_CODE_PERMISSION_TO_RELEASE
  4. PROBLEM_CODE_RESOURCE_UNAVAILABLE
  5. PROBLEM_CODE_UNASSIGNED_RESPONDING_ID
  6. PROBLEM_CODE_UNRECOGNIZED_PACKAGE_TYPE

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 Reject 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 Reject 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 Reject indication. Invoke Id identifies the operation invocation and its result. The mapping rules for the Invoke Identifier in an REJECT 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 reject indication event

Throws:

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

isRejectTypePresent

public boolean isRejectTypePresent()

Indicates if the Reject Type flag is present in this Event.

Returns:

true if Reject Type flag has been set.

getRejectType

public int getRejectType()
                  throws ParameterNotSetException

Indicates the type of this Reject Event.

Returns:

one of the following:

• REJECT_TYPE_USER
• REJECT_TYPE_REMOTE
• REJECT_TYPE_LOCAL

Throws:

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

See Also:

ComponentConstants

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

Returns:

the Parameters of the Reject indication Component

Throws:

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

getProblemType

public int getProblemType()
                   throws MandatoryParameterNotSetException

Returns the problem type of this Reject request Component.

Returns:

one of the following:

• PROBLEM_TYPE_GENERAL - a problem that does not relate to any specific component type.
• PROBLEM_TYPE_INVOKE - a problem that relates only to the invoke component type.
• PROBLEM_TYPE_RETURN_RESULT - a problem that relates to the return result component type.
• PROBLEM_TYPE_RETURN_ERROR - a problem that relates only to the return error component.
• PROBLEM_TYPE_DIALOGUE - a problem specific to a Dialogue primitive.

Throws:

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

See Also:

ComponentConstants

getProblem

public int getProblem()
               throws MandatoryParameterNotSetException

Returns the problem details of this Reject indication Component.

Returns:

the problem detail. One of the following problem codes, grouped by Problem type:

• PROBLEM_TYPE_GENERAL
  1. PROBLEM_CODE_BADLY_STRUCTURED_COMPONENT
  2. PROBLEM_CODE_MISTYPED_COMPONENT
  3. PROBLEM_CODE_UNRECOGNISED_COMPONENT
• PROBLEM_TYPE_INVOKE
  1. PROBLEM_CODE_DUPLICATE_INVOKE_ID
  2. PROBLEM_CODE_INITIATING_RELEASE
  3. PROBLEM_CODE_LINKED_RESPONSE_UNEXPECTED
  4. PROBLEM_CODE_MISTYPED_PARAMETER
  5. PROBLEM_CODE_RESOURCE_LIMITATION
  6. PROBLEM_CODE_UNEXPECTED_LINKED_OPERATION
  7. PROBLEM_CODE_UNRECOGNIZED_INVOKE_ID
  8. PROBLEM_CODE_UNRECOGNIZED_LINKED_ID
  9. PROBLEM_CODE_UNRECOGNIZED_OPERATION
• PROBLEM_TYPE_RETURN_RESULT
  1. PROBLEM_CODE_MISTYPED_PARAMETER
  2. PROBLEM_CODE_RETURN_RESULT_UNEXPECTED
  3. PROBLEM_CODE_UNRECOGNIZED_INVOKE_ID
• PROBLEM_TYPE_RETURN_ERROR
  1. PROBLEM_CODE_MISTYPED_PARAMETER
  2. PROBLEM_CODE_RETURN_ERROR_UNEXPECTED
  3. PROBLEM_CODE_UNRECOGNIZED_ERROR
  4. PROBLEM_CODE_UNRECOGNIZED_INVOKE_ID
• PROBLEM_TYPE_DIALOGUE
  1. PROBLEM_CODE_BADLY_STRUCTURED_DIALOGUE
  2. PROBLEM_CODE_INCORRECT_DIALOGUE
  3. PROBLEM_CODE_PERMISSION_TO_RELEASE
  4. PROBLEM_CODE_RESOURCE_UNAVAILABLE
  5. PROBLEM_CODE_UNASSIGNED_RESPONDING_ID
  6. PROBLEM_CODE_UNRECOGNIZED_PACKAGE_TYPE

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 RejectIndEvent

Overrides:

toString in class ComponentIndEvent

Returns:

String provides description of class RejectIndEvent