jain.protocol.ss7.tcap
Class DialogueReqEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.DialogueReqEvent
Direct Known Subclasses:
BeginReqEvent, ContinueReqEvent, EndReqEvent, UnidirectionalReqEvent, UserAbortReqEvent

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

A DialogueReqEvent is the superclass of all Dialogue Request primitives, which represent TCAP Dialogue Requests sent from a JainTcapProvider to a JainTcapListener. This type of Event will be processed by the processDialogueReqEvent method of the JainTcapListener. This class implements the java.lang.Cloneable interface, therefore all Dialogue Request 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
DialogueReqEvent(java.lang.Object source)
          Constructs a new DialogueReqEvent.
 
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 request 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 Request primitive.
 byte getQualityOfService()
          Gets the Quality of Service parameter.
 boolean isDialoguePortionPresent()
          Indicates if the Dialogue Portion parameter is present in this Event.
 boolean isQualityOfServicePresent()
          Indicates if the Quality of Service is present in this Event.
 void setDialogueId(int dialogueId)
          Sets the Dialogue Id parameter, of thid Dialogue Request Event.
 void setDialoguePortion(DialoguePortion dialoguePortion)
          Sets the Dialogue Portion of this Dialogue handling request primitive.
 void setQualityOfService(byte qualityOfService)
          Sets the Quality of Service.
 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

DialogueReqEvent

public DialogueReqEvent(java.lang.Object source)
Constructs a new DialogueReqEvent.
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 request primitive.
Returns:
the Dialogue portion of this Dialogue handling request primitive.
Throws:
ParameterNotSetException - this exception is thrown if this JAIN Optional parameter has not yet been set

setDialoguePortion

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

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException
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 BeginEvent
Throws:
MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not yet been set

setDialogueId

public void setDialogueId(int dialogueId)
Sets the Dialogue Id parameter, of thid Dialogue Request Event.
Parameters:
dialogueId - an int representing the Dialogue Id of the Begin request primtive.

isQualityOfServicePresent

public boolean isQualityOfServicePresent()
Indicates if the Quality of Service is present in this Event.
Returns:
true if Quality of Service has been set.

getQualityOfService

public byte getQualityOfService()
                         throws ParameterNotSetException
Gets the Quality of Service parameter. Quality of Service is an SCCP parameter that is required from the application.
Returns:
the Quality of Service parameter of the BeginEvent
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setQualityOfService

public void setQualityOfService(byte qualityOfService)
Sets the Quality of Service.
Parameters:
qos - the Quality of Service parameter of the BeginEvent

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 Request primitive.


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

Copyright - 2000 Sun Microsystems