jain.protocol.ss7.tcap.component
Class RejectIndEvent

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

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.0

Author:

Colm Hayden & Phelim O'Doherty

See Also:

Serialized Form

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

dialogueId, dialogueIdPresent, invokeId, invokeIdPresent, lastComponent, 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	getLinkId() Gets the link Id parameter of the REJECT indication component.
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() Indicates if the link Id parameter is present in this Event.
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 linkId) Sets the link Id parameter of the REJECT indication component.
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()

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

getDialogueId, getInvokeId, 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.

Method Detail

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

setRejectType

public void setRejectType(int rejectType)

Sets the type of this Reject as a Local, Remote or User Reject.

Parameters:

rejectType - one of the following:

• REJECT_TYPE_USER
• REJECT_TYPE_REMOTE
• REJECT_TYPE_LOCAL

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 REJECT 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 REJECT indication

Throws:

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

setLinkId

public void setLinkId(int linkId)

Sets the link Id parameter of the REJECT indication component.

Parameters:

value - the link Id of the REJECT 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 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

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the REJECT indication Component.

Parameters:

params - the Parameters of the REJECT indication Component.

getProblemType

public int getProblemType()
                   throws ParameterNotSetException

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:

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

setProblemType

public void setProblemType(int problemType)

Sets the problem type of this REJECT request Component.

Parameters:

problemType - the type of problem, this may be one of:

• 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.

getProblem

public int getProblem()
               throws ParameterNotSetException

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:

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

setProblem

public void setProblem(int problem)

Sets the problem details of this REJECT indication Component.

Parameters:

problem - 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

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()

Overrides:

toString in class java.util.EventObject