jain.protocol.ss7.tcap.dialogue
Class EndReqEvent
java.lang.Object
|
+--java.util.EventObject
|
+--jain.protocol.ss7.tcap.DialogueReqEvent
|
+--jain.protocol.ss7.tcap.dialogue.EndReqEvent
- public final class EndReqEvent
- extends DialogueReqEvent
An event representing a TCAP End request dialogue
primitive. This event will be passed from the 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 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 |
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()
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 |
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.
isTerminationPresent
public boolean isTerminationPresent()
- Indicates if the Termination parameter is present in this Event.
- Returns:
- true if Termination has been set.
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 ie one of the following.
- TC_BASIC_END
- TC_PREARRANGED_END
- Throws:
- ParameterNotSetException - this exception is thrown if this
parameter has not yet been set
setTermination
public void setTermination(int termination)
- Sets the Termination parameter of the End request primitive.
- Parameters:
termination
- the Termination of the EndReqEvent.
getPrimitiveType
public int getPrimitiveType()
- This method returns the type of this primitive.
- Overrides:
- getPrimitiveType in class DialogueReqEvent
clearAllParameters
public void clearAllParameters()
- Clears all previously set parameters .
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