jain.protocol.ss7.tcap.component
Class ResultIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class ResultIndEvent

extends ComponentIndEvent

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

ResultIndEvent(java.lang.Object source, int dialogueId, boolean lastComponent, boolean lastResultEvent)
Constructs a new Result 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 Result 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 result indication.
int	getLinkId() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
Operation	getOperation() Gets the Operation parameter of the Result indication Component.
Parameters	getParameters() Gets the Parameters' parameter of the Result indication Component.
int	getPrimitiveType() This method returns the type of this primitive.
boolean	isLastResultEvent() The LastResultEvent parameter determines whether a RESULT_L or a RESULT_NL component is being sent through the API.
boolean	isLinkIdPresent() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
boolean	isOperationPresent() Indicates if the optional Operation field is present in this Event.
boolean	isParametersPresent() Indicates if the 'Parameters' field is present in this Event.
void	setLastResultEvent(boolean lastResultEvent) The LastResultEvent parameter determines whether a RESULT_L or a RESULT_NL component is being sent through the API.
void	setLinkId(int value) Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
void	setOperation(Operation operation) Sets the Operation parameter of the Result Indication Component
void	setParameters(Parameters params) Sets the Parameters' parameter of the Result Indication Component.
java.lang.String	toString() String representation of class ResultIndEvent

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

ResultIndEvent

public ResultIndEvent(java.lang.Object source,
                      int dialogueId,
                      boolean lastComponent,
                      boolean lastResultEvent)

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

lastComponent - the Last Component Flag supplied to the constructor

lastResultEvent - the Last Result Event Flag supplied to the constructor

Method Detail

setLastResultEvent

public void setLastResultEvent(boolean lastResultEvent)

The LastResultEvent parameter determines whether a RESULT_L or a RESULT_NL component is being sent through the API.

Note to developers :- This field is mandatory to both an ITU and ANSI implementation of the JAIN TCAP API (unlike the lastInvokeEvent parameter in the InvokeIndEvent). It is defaulted to false that is a RESULT_NL component, in order to send an RESULT_L component the lastResultEvent parameter must be set to true.

Parameters:

lastResultEvent - The new LastResultEvent value

setOperation

public void setOperation(Operation operation)

Sets the Operation parameter of the Result Indication Component

Parameters:

operation - The new Operation value

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the Result Indication Component.

Parameters:

params - The new Parameters value

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

Throws:

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

isLastResultEvent

public boolean isLastResultEvent()

The LastResultEvent parameter determines whether a RESULT_L or a RESULT_NL component is being sent through the API.

Note to developers :- This field is mandatory to both an ITU and ANSI implementation of the JAIN TCAP API (unlike the lastInvokeEvent parameter in the InvokeIndEvent). It is defaulted to false that is a RESULT_NL component, in order to send an RESULT_L component the lastResultEvent parameter must be set to true.

Returns:

one of the following:-

• true - if this is a RESULT_L Component.
• false - if this is a RESULT_NL Component.

isOperationPresent

public boolean isOperationPresent()

Indicates if the optional Operation field is present in this Event.

Returns:

true if Operation has been set, false otherwise.

getOperation

public Operation getOperation()
                       throws ParameterNotSetException

Gets the Operation parameter of the Result indication Component. Operation identifies the action to be executed by the remote application.

Returns:

the Operation of the Result indication Component

Throws:

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

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

Returns:

the Parameters of the Result indication Component

Throws:

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

Overrides:

toString in class ComponentIndEvent

Returns:

String provides description of class ResultIndEvent