jain.protocol.ss7.tcap
Class ComponentIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentIndEvent
Direct Known Subclasses:
ErrorIndEvent, InvokeIndEvent, LocalCancelIndEvent, RejectIndEvent, ResultIndEvent

public abstract class ComponentIndEvent
extends java.util.EventObject
implements java.io.Serializable, java.lang.Cloneable

A ComponentIndEvent is the superclass of all Component Indication primitives, which represent TCAP Component Indications sent from a JainTcapProvider to a JainTcapListener. This type of Event will be processed by the processComponentIndEvent method of the JainTcapListener. This class implements the java.lang.Cloneable interface, therefore all Component Indication primitves that extend this Event can be cloned using the clone() method inherited from java.lang.Object.

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Constructor Summary
ComponentIndEvent(java.lang.Object source)
          Constructs a new ComponentIndEvent.
 
Method Summary
abstract  int getDialogueId()
          Gets the Dialogue Id parameter of the indication component, which is a reference identifier that is used to associate all components within a transaction.
abstract  int getInvokeId()
          Gets the Invoke Id parameter of the component indication.
abstract  int getPrimitiveType()
          This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Component Indication primitive.
 boolean isInvokeIdPresent()
          Indicates if the Invoke Id is present in this Event.
 boolean isLastComponent()
          Indicates if this indication Component is the last component.
 void setDialogueId(int dialogueId)
          Sets the Dialogue Id parameter of this Component Indication Event.
 void setInvokeId(int invokeId)
          Sets the Invoke Id parameter of the indication component.
 void setLastComponent(boolean lastComponent)
          Sets this indication Component as the last component.
 void setSource(java.lang.Object source)
          Sets the source of this event.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ComponentIndEvent

public ComponentIndEvent(java.lang.Object source)
Constructs a new ComponentIndEvent.
Parameters:
source - the source of this Event.
Method Detail

setSource

public void setSource(java.lang.Object source)
Sets the source of this event. This method may be used as an alternative to setting the event source through the constructor and allows the capability to clone the Event and change the Event source at any time.
Parameters:
source - the source of this Event.

getDialogueId

public abstract int getDialogueId()
                           throws ParameterNotSetException,
                                  MandatoryParameterNotSetException
Gets the Dialogue Id parameter of the indication component, which is a reference identifier that is used to associate all components within a transaction.
Returns:
the Dialogue Id of the Component indication
Throws:
ParameterNotSetException - this exception is thrown if this parameter is a JAIN optional parameter and has not yet been set. The Dialogue Id is JAIN Optional for the Invoke Indication.
MandatoryParameterNotSetException - this exception is thrown if the Dialogue Id is a JAIN mandatory parameter for the specific Component Indication. The Dialogue Id is JAIN Mandatory for all component indications except for the Invoke Indication.

setDialogueId

public void setDialogueId(int dialogueId)
Sets the Dialogue Id parameter of this Component Indication Event. Dialogue Id is a reference identifier which is used to associate all components within a transaction.
Parameters:
value - the Dialogue Id of the indication

isInvokeIdPresent

public boolean isInvokeIdPresent()
Indicates if the Invoke Id is present in this Event.
Returns:
true if Invoke Id has been set.

getInvokeId

public abstract int getInvokeId()
                         throws ParameterNotSetException,
                                MandatoryParameterNotSetException
Gets the Invoke Id parameter of the component indication. Invoke Id identifies the an operation invocation and its result.
Returns:
the Invoke Id of the indication event
Throws:
ParameterNotSetException - this exception is thrown if this is a JAIN Optional parameter in the specific component indication and has not been set
MandatoryParameterNotSetException - if this this is a JAIN Mandatory parameter in the specific component indication and has not been set

setInvokeId

public void setInvokeId(int invokeId)
Sets the Invoke Id parameter of the indication component. Invoke Id identifies the an operation invocation and its result.
Parameters:
value - the Invoke Id of the indication

isLastComponent

public boolean isLastComponent()
Indicates if this indication Component is the last component. By default the last component parameter is set to false.
Returns:
true if this is the last component, false otherwise

setLastComponent

public void setLastComponent(boolean lastComponent)
Sets this indication Component as the last component. Note that by default this component will not be the last Component. ie - lastComponent by default is set to false.
Parameters:
lastComponent - indicates if this is the last component

getPrimitiveType

public abstract int getPrimitiveType()
This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Component Indication primitive.


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

Copyright - 2000 Sun Microsystems