jain.protocol.ss7.tcap.component
Class LocalCancelIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class LocalCancelIndEvent

extends ComponentIndEvent

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

LocalCancelIndEvent(java.lang.Object source, int dialogueId, int invokeId)
Constructs a new Local Cancel 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 Local Cancel Indication, which is a reference identifier that is used to associate all components within a transaction.
int	getInvokeId() Gets the Invoke Id parameter of this Local Cancel indication.
int	getPrimitiveType() This method returns the type of this primitive.
java.lang.String	toString() String representation of class LocalCancelIndEvent

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

LocalCancelIndEvent

public LocalCancelIndEvent(java.lang.Object source,
                           int dialogueId,
                           int invokeId)

Constructs a new Local Cancel 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

invokeId - the Invoke Identifier supplied to the constructor

Method Detail

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException

Gets the Dialogue Id parameter of this Local Cancel Indication, which is a reference identifier that is used to associate all components within a transaction.

Overrides:

getDialogueId in class ComponentIndEvent

Returns:

the Dialogue Id of this Local Cancel indication

Throws:

MandatoryParameterNotSetException - if this JAIN Mandatory parameter has not been set.

getInvokeId

public int getInvokeId()
                throws MandatoryParameterNotSetException

Gets the Invoke Id parameter of this Local Cancel indication. Invoke Id identifies the operation invocation and its result.

Overrides:

getInvokeId in class ComponentIndEvent

Returns:

the Invoke Id of the indication event

Throws:

MandatoryParameterNotSetException - this exception is thrown if this is a JAIN Mandatory 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 LocalCancelIndEvent

Overrides:

toString in class ComponentIndEvent

Returns:

String provides description of class LocalCancelIndEvent