jain.protocol.ss7.tcap.dialogue
Class EndIndEvent
java.lang.Object
|
+--java.util.EventObject
|
+--jain.protocol.ss7.tcap.DialogueIndEvent
|
+--jain.protocol.ss7.tcap.dialogue.EndIndEvent
- public final class EndIndEvent
- extends DialogueIndEvent
An event representing a TCAP End indication dialogue
primitive. This event will be passed from the Provider (TCAP) to the Listener(the TC User) to
indicate the termination of a structured dialogue with the originating
node.
The mandatory parameters of this primitive are supplied
to the constructor. Optional parameters may then be set using the
set methods.
The optional paramters 'Application Context Name' and 'User Information' are
centrally located in the Dialogue Portion class, therefore to manipulate them it is necessary
it instantiate the Dialogue Portion Object and use the acessors method for the two
parameters in that Dialogue Portion Object.
- Version:
- 1.0
- Author:
- Colm Hayden & Phelim O'Doherty
- See Also:
- Serialized Form
Fields inherited from class java.util.EventObject |
source |
Constructor Summary |
EndIndEvent(java.lang.Object source,
int dialogueId,
boolean componentsPresent)
Constructs a new EndIndEvent, 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 and
resets the 'Components Present' flag to false. |
int |
getPrimitiveType()
This method returns the type of this primitive. |
byte |
getQualityOfService()
Gets the Quality of Service parameter of the End indication primitive. |
boolean |
isComponentsPresent()
Reteurns the Components present flag of this End indication primitive. |
boolean |
isQualityOfServicePresent()
Indicates if the Quality of Service parameter is present in this Event. |
void |
setComponentsPresent(boolean componentsPresent)
Sets the Components present parameter of this End indication primitive. |
void |
setQualityOfService(byte qualityOfService)
Sets the Quality of Service parameter of the End indication primitive. |
java.lang.String |
toString()
Returns a string representation of an instance of this class. |
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 |
EndIndEvent
public EndIndEvent(java.lang.Object source,
int dialogueId,
boolean componentsPresent)
- Constructs a new EndIndEvent, with only the Event Source and the
JAIN TCAP Mandatory parameters
being supplied to the constructor.
isQualityOfServicePresent
public boolean isQualityOfServicePresent()
- Indicates if the Quality of Service parameter 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 of the End indication primitive.
Quality of Service is an SCCP parameter that is required from the application.
- Returns:
- the Quality of Service parameter of the EndEvent
- 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 parameter of the End indication primitive.
- Parameters:
qos
- the Quality of Service parameter of the EndEvent
getPrimitiveType
public int getPrimitiveType()
- This method returns the type of this primitive.
- Overrides:
- getPrimitiveType in class DialogueIndEvent
setComponentsPresent
public void setComponentsPresent(boolean componentsPresent)
- Sets the Components present parameter of this End indication primitive.
This flag is used to determine if their are any components associated with this primitive.
This flag will be reset to false when the clearAllParameters()
method is invoked.
- Parameters:
componentsPresent
- the Components Present of the EndEvent.
isComponentsPresent
public boolean isComponentsPresent()
- Reteurns the Components present flag of this End indication primitive.
This flag is used to determine if their are any components associated with this primitive.
This flag will be reset to false when the clearAllParameters()
method is invoked.
- Returns:
- the Components Present of the EndEvent.
clearAllParameters
public void clearAllParameters()
- Clears all previously set parameters and
resets the 'Components Present' flag to false.
toString
public java.lang.String toString()
- Returns a string representation of an instance of this class.
- Overrides:
- toString in class java.util.EventObject
01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.ComCopyright - 1999 Sun Microsystems