JAIN TCAP API Specification: Class InvokeReqEvent

Overview

Package

Class

Tree

Deprecated

Index

Help

JAIN TCAP API
v1.1 - 5th Sept 2001

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jain.protocol.ss7.tcap.component
Class InvokeReqEvent

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

All Implemented Interfaces:: java.lang.Cloneable, java.io.Serializable

public final class InvokeReqEvent
extends ComponentReqEvent

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

InvokeReqEvent(java.lang.Object source, int dialogueId, Operation operation)
          Constructs a new Invoke 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 getClassType()
          Returns the Component Class type.

int getLinkedId()
          Gets the linked Id parameter of the INVOKE indication component.

int getLinkId()
          Deprecated. As of JAIN TCAP v1.1. Use the getLinkedId method instead.

Operation getOperation()
          Gets the Operation parameter of the INVOKE request Component.

Parameters getParameters()
          Gets the Parameters' parameter of the INVOKE request Component.

int getPrimitiveType()
          This method returns the type of this primitive.

long getTimeOut()
          Gets the Timeout parameter of the INVOKE request component.

boolean isClassTypePresent()
          Indicates if the Class type field is present in this Event.

boolean isInvokeIdPresent()
          Indicates if the Invoke Id is present in this Event.

boolean isLastInvokeEvent()
          Indicates if this is the last Invoke Event.

boolean isLinkedIdPresent()
          Indicates if this optional linked Id (correlation Id) parameter is present in this Event.

boolean isLinkIdPresent()
          Deprecated. As of JAIN TCAP v1.1. Use the isLinkedPresent method instead.

boolean isParametersPresent()
          Indicates if the 'Parameters' field is present in this Event.

boolean isTimeOutPresent()
          Indicates if the Timeout field is present in this Event.

void setClassType(int classType)
          Sets the Class Type parameter of the INVOKE request component.

void setLastInvokeEvent(boolean lastInvokeEvent)
          Sets the lastInvoke flag of this Invoke Event.

void setLinkedId(int linkedId)
          Sets the linked Id parameter of the INVOKE indication component.

void setLinkId(int value)
          Deprecated. As of JAIN TCAP v1.1. Use the setLinkedId method instead.

void setOperation(Operation operation)
          Sets the Operation parameter of the Invoke request Component

void setParameters(Parameters params)
          Sets the Parameters' parameter of the Invoke request Component.

void setTimeOut(long timeOut)
          Sets the Timeout parameter of the INVOKE request component.

java.lang.String toString()
          String representation of class InvokeReqEvent

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

InvokeReqEvent

public InvokeReqEvent(java.lang.Object source,
                      int dialogueId,
                      Operation operation)

Constructs a new Invoke 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 Identifier supplied to the constructor; operation - the Operation supplied to the constructor

Method Detail

setLastInvokeEvent

public void setLastInvokeEvent(boolean lastInvokeEvent)

Sets the lastInvoke flag of this Invoke Event. The InvokeLastEvent parameter determines whether an INVOKE_L or an INVOKE_NL component is being sent through the API. It is defaulted to false i.e. an INVOKE_NL component, in order to send an INVOKE_L component the InvokeLastEvent parameter must be set to true. NOTE: This field is not used by ITU implementation, however it is mandatory for ANSI.

Parameters:: lastInvoke - true if this is an INVOKE_L Event, false if this is an INVOKE_NL Event.

setLinkId

public void setLinkId(int value)

Deprecated. As of JAIN TCAP v1.1. Use the setLinkedId method instead.

setLinkedId

public void setLinkedId(int linkedId)

Sets the linked Id parameter of the INVOKE indication component. The linked Id parameter links an operation invocation to a previous operation invocation by the remote TCAP application. Note to developers :- The mapping of the Linked Identifier is as follows:

The Linked Identifier is the Linked Identifier as specified in the ITU recommendation for the INVOKE component.
The Linked Identifier is the Correlation Identifier as specified in the ANSI recommendation for the INVOKE_L and INVOKE_NL components.

Parameters:: linkedId - The new Linked Identifier value

setTimeOut

public void setTimeOut(long timeOut)

Sets the Timeout parameter of the INVOKE request component.

Parameters:: timeOut - The new Time Out value

setOperation

public void setOperation(Operation operation)

Sets the Operation parameter of the Invoke request Component

Parameters:: operation - The new Operation value

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the Invoke request Component.

Parameters:: params - The new Parameters value

setClassType

public void setClassType(int classType)

Sets the Class Type parameter of the INVOKE request component.

Parameters:

one - of the following:

CLASS_1 - Reporting success or failure
CLASS_2 - Reporting failure
CLASS_3 - Reporting success
CLASS_4 - Outcome not reported

isInvokeIdPresent

public boolean isInvokeIdPresent()

Indicates if the Invoke Id is present in this Event.

Returns:: true if Invoke Identifier has been set, false otherwise.

isLastInvokeEvent

public boolean isLastInvokeEvent()

Indicates if this is the last Invoke Event. The InvokeLastEvent parameter determines whether an INVOKE_L or an INVOKE_NL component is being sent through the API. It is defaulted to false i.e. an INVOKE_NL component, in order to send an INVOKE_L component the InvokeLastEvent parameter must be set to true. NOTE: This field is not used by ITU implementation, however it is mandatory for ANSI.

Returns:: true if this is an INVOKE_L Event, false if this is an INVOKE_NL Event.

isLinkIdPresent

public boolean isLinkIdPresent()

Deprecated. As of JAIN TCAP v1.1. Use the isLinkedPresent method instead.

getLinkId

public int getLinkId()
              throws ParameterNotSetException

Deprecated. As of JAIN TCAP v1.1. Use the getLinkedId method instead.

isLinkedIdPresent

public boolean isLinkedIdPresent()

Indicates if this optional linked Id (correlation Id) parameter is present in this Event. Update v1.1: Added get/setLinkedId/isPresent methods to incur with standards variable naming and clarified mapping between ITU and ANSI standards.

Returns:: true if linked Id (correlation Id) has been set, false otherwise.

getLinkedId

public int getLinkedId()
                throws ParameterNotSetException

Gets the linked Id parameter of the INVOKE indication component. The linked Id parameter links an operation invocation to a previous operation invocation by the remote TCAP application.

Note to developers :- The mapping of the Linked Identifier is as follows:

The Linked Identifier is the Linked Identifier as specified in the ITU recommendation for the INVOKE component.
The Linked Identifier is the Correlation Identifier as specified in the ANSI recommendation for the INVOKE_L and INVOKE_NL components.

Returns:: the linked Id (correlationId) of the INVOKE indication component
Throws:: ParameterNotSetException - this exception is thrown if this parameter has not been set

isTimeOutPresent

public boolean isTimeOutPresent()

Indicates if the Timeout field is present in this Event.

Returns:: true if Timeout has been set, false otherwise.

getTimeOut

public long getTimeOut()
                throws ParameterNotSetException

Gets the Timeout parameter of the INVOKE request component. Timeout indicates the amount of time to wait for a response to an invocation.

Returns:: the timeout value in milliseconds
Throws:: ParameterNotSetException - this exception is thrown if this parameter has not been set

getOperation

public Operation getOperation()
                       throws MandatoryParameterNotSetException

Gets the Operation parameter of the INVOKE request Component. .Operation identifies the action to be executed by the remote application.

Returns:: the Operation of the INVOKE request Component
Throws:: MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory 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 INVOKE request Component.


 Parameters

contains any parameters that accompany an operation or that are provided in reply to an operation.

Returns:: the Parameters of the INVOKE request Component
Throws:: ParameterNotSetException - this exception is thrown if this parameter has not been set

isClassTypePresent

public boolean isClassTypePresent()

Indicates if the Class type field is present in this Event.

Returns:: true if the Class type has been set, false otherwise.

getClassType

public int getClassType()
                 throws ParameterNotSetException

Returns the Component Class type.

Returns:

one of the following:

CLASS_1 - Reporting success or failure
CLASS_2 - Reporting failure
CLASS_3 - Reporting success
CLASS_4 - Outcome not reported

Throws:

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

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 InvokeReqEvent

Overrides:: toString in class ComponentReqEvent

Returns:: String provides description of class InvokeReqEvent