jain.protocol.ss7.tcap.dialogue
Class EndIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.DialogueIndEvent
              |
              +--jain.protocol.ss7.tcap.dialogue.EndIndEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

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 parameters 'Application Context Name' and 'User Information' are centrally located in the Dialogue Portion class, therefore to manipulate them it is necessary to instantiate the Dialogue Portion Object and use the accessors method for the two parameters in that Dialogue Portion Object.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

DialogueIndEvent, Serialized Form

Fields inherited from class jain.protocol.ss7.tcap.DialogueIndEvent

m_dialogueId, m_dialogueIdPresent, m_dialoguePortion, m_dialoguePortionPresent

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() Returns 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() String representation of class EndIndEvent

Methods inherited from class jain.protocol.ss7.tcap.DialogueIndEvent

getDialogueId, getDialoguePortion, isDialoguePortionPresent, setDialogueId, setDialoguePortion, setSource

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

Constructor Detail

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.

Parameters:

source - the Event Source supplied to the constructor

dialogueId - the Dialogue Identifier supplied to the constructor

componentsPresent - the Components Present Flag supplied to the constructor

Method Detail

setQualityOfService

public void setQualityOfService(byte qualityOfService)

Sets the Quality of Service parameter of the End indication primitive.

Parameters:

qualityOfService - The new Quality Of Service value

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 new Components Present Flag

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, false otherwise.

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

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueIndEvent

Returns:

The Primitive Type of this Event

isComponentsPresent

public boolean isComponentsPresent()

Returns 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()

String representation of class EndIndEvent

Overrides:

toString in class DialogueIndEvent

Returns:

String provides description of class EndIndEvent