jain.protocol.ss7.tcap.component
Class LocalCancelIndEvent

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

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.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

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()
           
 
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
equals, 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.
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.
Returns:
the Dialogue Id of this Local Cancel indication
Throws:
MandatoryParameterNotSetException - if this JAIN Mandatory parameter has not been set.
Overrides:
getDialogueId in class ComponentIndEvent

getInvokeId

public int getInvokeId()
                throws MandatoryParameterNotSetException
Gets the Invoke Id parameter of this Local Cancel indication. Invoke Id identifies the an operation invocation and its result.
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
Overrides:
getInvokeId in class ComponentIndEvent

getPrimitiveType

public int getPrimitiveType()
This method returns the type of this primitive.
Overrides:
getPrimitiveType in class ComponentIndEvent

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters .

toString

public java.lang.String toString()
Overrides:
toString in class java.util.EventObject


28 June 2000
If you have any comments or queries, please mail them to JainTcapApiFeedback@AePONA.Com

Copyright - 2000 Sun Microsystems