jain.protocol.ss7.tcap.dialogue
Class EndReqEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.DialogueReqEvent
              |
              +--jain.protocol.ss7.tcap.dialogue.EndReqEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class EndReqEvent

extends DialogueReqEvent

An event representing a TCAP End request dialogue primitive. This event will be passed from the Listener (the TC User) to the Provider (TCAP) to end a transaction with the destination node. No component can be sent or received for a transaction once the end request has been issued. If the Termination parameter is set to TC_BASIC_END this Event indicates a basic dialogue termination ending and any pending components will be sent to the destination node. If the Termination parameter is set to TC_PRE_ARRANGED_END this Event indicates a pre-arranged dialogue termination ending no pending components will be sent to the destination 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:

DialogueReqEvent, Serialized Form

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

m_dialogueId, m_dialogueIdPresent, m_dialoguePortion, m_dialoguePortionPresent, m_qualityOfService, m_qualityOfServicePresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

EndReqEvent(java.lang.Object source, int dialogueId)
Constructs a new EndReqEvent, 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.
int	getPrimitiveType() This method returns the type of this primitive.
int	getTermination() Gets the termination parameter of the End request primitive.
boolean	isTerminationPresent() Indicates if the Termination parameter is present in this Event.
void	setTermination(int termination) Sets the Termination parameter of the End request primitive.
java.lang.String	toString() String representation of class EndReqEvent

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

getDialogueId, getDialoguePortion, getQualityOfService, isDialoguePortionPresent, isQualityOfServicePresent, setDialogueId, setDialoguePortion, setQualityOfService, 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

EndReqEvent

public EndReqEvent(java.lang.Object source,
                   int dialogueId)

Constructs a new EndReqEvent, 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

Method Detail

setTermination

public void setTermination(int termination)

Sets the Termination parameter of the End request primitive.

Parameters:

one - of the following:

• TC_BASIC_END
• TC_PRE_ARRANGED_END

See Also:

DialogueConstants

isTerminationPresent

public boolean isTerminationPresent()

Indicates if the Termination parameter is present in this Event.

Returns:

true if Termination has been set, false otherwise.

getTermination

public int getTermination()
                   throws ParameterNotSetException

Gets the termination parameter of the End request primitive. The Termination parameter indicates which scenario is chosen by the application for the end of the dialogue

Returns:

the Termination of the EndReqEvent, one of the following:

• TC_BASIC_END
• TC_PREARRANGED_END

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not been set

See Also:

DialogueConstants

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueReqEvent

Returns:

The Primitive Type of this Event

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters.

toString

public java.lang.String toString()

String representation of class EndReqEvent

Overrides:

toString in class DialogueReqEvent

Returns:

String provides description of class EndReqEvent