jain.protocol.ss7.tcap.component
Class ResultReqEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class ResultReqEvent

extends ComponentReqEvent

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

ResultReqEvent(java.lang.Object source, int dialogueId, boolean lastResultEvent)
Constructs a new Result 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.
Operation	getOperation() Gets the Operation parameter of the Result request Component.
Parameters	getParameters() Gets the Parameters' parameter of the Result 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	isLastResultEvent() Indicates if the Last Result Component Event.
boolean	isLinkIdPresent() Deprecated. As of JAIN TCAP v1.1. No replacement - no function for parameter.
boolean	isOperationPresent() Indicates if the Operation field is present in this Event.
boolean	isParametersPresent() Indicates if the 'Parameters' field is present in this Event.
void	setLastResultEvent(boolean lastResultEvent) Sets the lastResult flag of the Result request component.
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 Request Component
void	setParameters(Parameters params) Sets the Parameters' parameter of the Result Request Component.
java.lang.String	toString() String representation of class ResultReqEvent

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

ResultReqEvent

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

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

dialogueId - the Dialogue Id supplied to the constructor

lastResultEvent - the Last Result Event flag supplied to the constructor

Method Detail

setLastResultEvent

public void setLastResultEvent(boolean lastResultEvent)

Sets the lastResult flag of the Result request component. The LastResultEvent parameter determines whether an RESULT_L or an RESULT_NL component is being sent through the API. It is defaulted to false i.e. an RESULT_NL component, in order to send an RESULT_L component the LastResultEvent parameter must be set to true.

Parameters:

lastResultEvent - The LastResultEvent value

setOperation

public void setOperation(Operation operation)

Sets the Operation parameter of the Result Request Component

Parameters:

operation - The new Operation value

setParameters

public void setParameters(Parameters params)

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

isInvokeIdPresent

public boolean isInvokeIdPresent()

Indicates if the Invoke Id is present in this Event.

Returns:

true if Invoke Id has been set.

isLastResultEvent

public boolean isLastResultEvent()

Indicates if the Last Result Component Event. The LastResultEvent parameter determines whether an RESULT_L or an RESULT_NL component is being sent through the API. It is defaulted to false i.e. an RESULT_NL component, inorder to send an RESULT_L component the LastResultEvent parameter must be set to true.

Returns:

true if this is the Last Result Component.

isOperationPresent

public boolean isOperationPresent()

Indicates if the 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 request Component. Operation identifies the action to be executed by the remote application.

Returns:

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

Returns:

the Parameters of the RESULT request 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 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 ResultReqEvent

Overrides:

toString in class ComponentReqEvent

Returns:

String provides description of class ResultReqEvent