JAIN TCAP API Specification: Class InvokeIndEvent

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 InvokeIndEvent

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

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

public final class InvokeIndEvent
extends ComponentIndEvent

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

InvokeIndEvent(java.lang.Object source, Operation operation, boolean lastComponent)
          Constructs a new Invoke 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 Invoke 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 invoke indication.

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 indication Component.

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

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

boolean isDialogueIdPresent()
          Indicates if the Dialogue Id is present in this Event.

boolean isLastInvokeEvent()
          The InvokeLastEvent parameter determines whether an INVOKE_L or an INVOKE_NL component is being sent through the API for an ANSI implementation of the JAIN TCAP API.

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.

void setLastInvokeEvent(boolean lastInvokeEvent)
          The InvokeLastEvent parameter determines whether an INVOKE_L or an INVOKE_NL component is being sent through the API.

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

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

java.lang.String toString()
          String representation of class jain.protocol.ss7.tcap.component.InvokeIndEvent

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

InvokeIndEvent

public InvokeIndEvent(java.lang.Object source,
                      Operation operation,
                      boolean lastComponent)

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

Method Detail

setLastInvokeEvent

public void setLastInvokeEvent(boolean lastInvokeEvent)

The InvokeLastEvent parameter determines whether an INVOKE_L or an INVOKE_NL component is being sent through the API. It is defaulted to false that is an INVOKE_NL component, in order to send an INVOKE_L component the InvokeLastEvent parameter must be set to true.

Note to developers: This field is not used by an ITU implementation, however it is mandatory for ANSI implementation.

Parameters:: lastInvokeEvent - determines if this is an INVOKE_L or INVOKE_NL for an ANSI implementation of the JAIN TCAP API.

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

setOperation

public void setOperation(Operation operation)

Sets the Operation parameter of the Invoke indication Component

Parameters:: operation - The new Operation value

setParameters

public void setParameters(Parameters params)

Sets the Parameters' parameter of the Invoke indication Component.

Parameters:: params - The new Parameters value

getDialogueId

public int getDialogueId()
                  throws ParameterNotSetException

Gets the Dialogue Id parameter of this Invoke 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 Invoke indication
Throws:: ParameterNotSetException - if this JAIN Optional parameter has not been set.

getInvokeId

public int getInvokeId()
                throws ParameterNotSetException

Gets the Invoke Id parameter of this invoke indication. Invoke Id identifies the operation invocation and its result. The mapping rules for the Invoke Identifier in an INVOKE Component are:-
The Invoke Identifier is the Invoke Identifier as specified in both the ITU and ANSI recommendations for the Invoke component.

Overrides:: getInvokeId in class ComponentIndEvent

Returns:: the Invoke Id of the invoke indication event
Throws:: ParameterNotSetException - this exception is thrown if this is a JAIN Optional parameter has not been set

isDialogueIdPresent

public boolean isDialogueIdPresent()

Indicates if the Dialogue Id is present in this Event.

Returns:: true if Dialogue Id has been set, false otherwise.

isLastInvokeEvent

public boolean isLastInvokeEvent()

The InvokeLastEvent parameter determines whether an INVOKE_L or an INVOKE_NL component is being sent through the API for an ANSI implementation of the JAIN TCAP API.

Note to developers : This field is not used by an ITU implementation, however it is mandatory for ANSI implementation.

Returns:

one of the following:-

true - if this is an INVOKE_L component
false - if this is an INVOKE_NL component

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

getOperation

public Operation getOperation()
                       throws MandatoryParameterNotSetException

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

Returns:: the Operation of the INVOKE indication 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 indication Component.


 Parameters

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

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

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 jain.protocol.ss7.tcap.component.InvokeIndEvent

Overrides:: toString in class ComponentIndEvent

Returns:: String provides description of class jain.protocol.ss7.tcap.component.InvokeIndEvent