jain.protocol.ss7.tcap
Class DialogueIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.DialogueIndEvent
Direct Known Subclasses:
BeginIndEvent, ContinueIndEvent, EndIndEvent, NoticeIndEvent, ProviderAbortIndEvent, UnidirectionalIndEvent, UserAbortIndEvent

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

A DialogueIndEvent is the superclass of all Dialogue Indication primitives, which represent TCAP Dialogue Indications sent from a JainTcapProvider to a JainTcapListener. This type of Event will be processed by the processDialogueIndEvent method of the JainTcapListener. This class implements the java.lang.Cloneable interface, therefore all Dialogue Indication primitives 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

Field Summary
protected  int dialogueId
          The Dialogue Id parameter.
protected  boolean dialogueIdPresent
           
protected  DialoguePortion dialoguePortion
          The Dialogue Portion of this Dialogue handling indication primitive.
protected  boolean dialoguePortionPresent
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DialogueIndEvent(java.lang.Object source)
          Constructs a new DialogueIndEvent.
 
Method Summary
 int getDialogueId()
          Gets the Dialogue Id parameter, which is a reference identifier that is used to associate all messages within a transaction.
 DialoguePortion getDialoguePortion()
          Returns the Dialogue Portion of this Dialogue handling indication primitive.
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 Dialogue Indication primitive.
 boolean isDialoguePortionPresent()
          Indicates if the Dialogue Portion parameter is present in this Event.
 void setDialogueId(int dialogueId)
          Sets the Dialogue Id parameter of this Dialogue Indiciation Event.
 void setDialoguePortion(DialoguePortion dialoguePortion)
          Sets the Dialogue Portion of this Dialogue handling indication primitive.
 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dialogueId

protected int dialogueId
The Dialogue Id parameter.

dialogueIdPresent

protected boolean dialogueIdPresent

dialoguePortion

protected DialoguePortion dialoguePortion
The Dialogue Portion of this Dialogue handling indication primitive.

dialoguePortionPresent

protected boolean dialoguePortionPresent
Constructor Detail

DialogueIndEvent

public DialogueIndEvent(java.lang.Object source)
Constructs a new DialogueIndEvent.
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.

isDialoguePortionPresent

public boolean isDialoguePortionPresent()
Indicates if the Dialogue Portion parameter is present in this Event.
Returns:
true if Dialogue Portion has been set.

getDialoguePortion

public DialoguePortion getDialoguePortion()
                                   throws ParameterNotSetException
Returns the Dialogue Portion of this Dialogue handling indication primitive.
Returns:
the Dialogue portion of this Dialogue handling indication primitive.
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setDialoguePortion

public void setDialoguePortion(DialoguePortion dialoguePortion)
Sets the Dialogue Portion of this Dialogue handling indication primitive.
Parameters:
dialoguePortion - the dialogue portion of this Dialogue handling indication primitive.

getDialogueId

public int getDialogueId()
                  throws ParameterNotSetException
Gets the Dialogue Id parameter, which is a reference identifier that is used to associate all messages within a transaction. It is determined uniquely by the local TCAP layer and given to the application for all transactions received or initiated by the local application.
Returns:
the Dialogue Id of the DialogueIndEvent
Throws:
ParameterNotSetException - this exception is thrown if this Mandatoryparameter has not yet been set

setDialogueId

public void setDialogueId(int dialogueId)
Sets the Dialogue Id parameter of this Dialogue Indiciation Event.
Parameters:
dialogueId - an 'int' representing the Dialogue Id of the Begin request primtive.

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 Dialogue Indication primitive.


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems