jain.protocol.ss7.tcap.component
Class RejectReqEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class RejectReqEvent

extends ComponentReqEvent

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

RejectReqEvent(java.lang.Object source, int dialogueId, int problemType, int problem)
Constructs a new Reject 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 .
int	getLinkId() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
Parameters	getParameters() Gets the Parameters' parameter of the Reject request Component.
int	getPrimitiveType() This method returns the type of this primitive.
int	getProblem() Returns the problem details of this Reject request Component.
int	getProblemType() Returns the problem type of this Reject request Component.
int	getRejectType() Deprecated. As of JAIN TCAP v1.1, only one type of Reject Request for each variant.
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.
boolean	isRejectTypePresent() Deprecated. As of JAIN TCAP v1.1, only one type of Reject Request for each variant.
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 Request Component.
void	setProblem(int problem) Sets the problem details of this Reject request Component.
void	setProblemType(int problemType) Sets the problem type of this Reject request Component.
void	setRejectType(int rejectType) Deprecated. As of JAIN TCAP v1.1, only one type of Reject Request for each variant.
java.lang.String	toString() String representation of class RejectReqEvent

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

RejectReqEvent

public RejectReqEvent(java.lang.Object source,
                      int dialogueId,
                      int problemType,
                      int problem)

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

dialogueId - the Dialogue Identifier supplied to the construcutor

problemType - the Problem Type supplied to the construcutor

problem - the Problem supplied to the construcutor

Method Detail

setRejectType

public void setRejectType(int rejectType)

Deprecated. As of JAIN TCAP v1.1, only one type of Reject Request for each variant.

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the Reject Request 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 Problem Type 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.

setProblem

public void setProblem(int problem)

Sets the problem details of this Reject request 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.

isInvokeIdPresent

public boolean isInvokeIdPresent()

Indicates if the Invoke Id is present in this Event.

Returns:

true if Invoke Id has been set, false otherwise.

isRejectTypePresent

public boolean isRejectTypePresent()

Deprecated. As of JAIN TCAP v1.1, only one type of Reject Request for each variant.

getRejectType

public int getRejectType()
                  throws ParameterNotSetException

Deprecated. As of JAIN TCAP v1.1, only one type of Reject Request for each variant.

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

Returns:

the Parameters of the Reject request Component

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not 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 yet been set

getProblem

public int getProblem()
               throws ParameterNotSetException

Returns the problem details of this Reject request Component.

Returns:

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:

ParameterNotSetException - this exception is thrown if this 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 RejectReqEvent

Overrides:

toString in class ComponentReqEvent

Returns:

String provides description of class RejectReqEvent