jain.protocol.ss7.tcap.dialogue
Class UserAbortReqEvent
java.lang.Object
|
+--java.util.EventObject
|
+--jain.protocol.ss7.tcap.DialogueReqEvent
|
+--jain.protocol.ss7.tcap.dialogue.UserAbortReqEvent
- public final class UserAbortReqEvent
- extends DialogueReqEvent
An event representing a TCAP UserAbort request dialogue
primitive. This event will be passed from the Listener (the TC User) to
the Provider (TCAP) to request the abrupt termination of a dialogue. No
pending components will be transmitted 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.
- Version:
- 1.0
- Author:
- Colm Hayden & Phelim O'Doherty
- See Also:
- Serialized Form
Fields inherited from class java.util.EventObject |
source |
Constructor Summary |
UserAbortReqEvent(java.lang.Object source,
int dialogueId)
Constructs a new UserAbortReqEvent, 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 |
getAbortReason()
Gets the abort reason parameter of the UserAbort request primitive. |
int |
getPrimitiveType()
This method returns the type of this primitive. |
byte[] |
getUserAbortInformation()
Gets the User Abort Information parameter of the UserAbort request primitive. |
boolean |
isAbortReasonPresent()
Indicates if the abort reason parameter is present in this Event. |
boolean |
isUserAbortInformationPresent()
Indicates if the User Abort Information parameter is present in this Event. |
void |
setAbortReason(int abortReason)
Sets the Abort Reason parameter of the UserAbort request primitive. |
void |
setUserAbortInformation(byte[] userAbortInformation)
Sets the User Abort Information parameter of the UserAbort 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 |
UserAbortReqEvent
public UserAbortReqEvent(java.lang.Object source,
int dialogueId)
- Constructs a new UserAbortReqEvent, with only the Event Source and the
JAIN TCAP Mandatory parameters
being supplied to the constructor.
isUserAbortInformationPresent
public boolean isUserAbortInformationPresent()
- Indicates if the User Abort Information parameter is present in this Event.
- Returns:
- true if User Abort Information has been set.
getUserAbortInformation
public byte[] getUserAbortInformation()
throws ParameterNotSetException
- Gets the User Abort Information parameter of the UserAbort request primitive.
User Information is the information which can be exchanged between TCAP
applications independently from the remote operation service.
- Returns:
- the User Abort Information of the UserAbortEvent.
- Throws:
- ParameterNotSetException - this exception is thrown if this
parameter has not yet been set
setUserAbortInformation
public void setUserAbortInformation(byte[] userAbortInformation)
- Sets the User Abort Information parameter of the UserAbort request primitive.
- Parameters:
userAbortInfo
- the User Abort Information of the UserAbortEvent.
isAbortReasonPresent
public boolean isAbortReasonPresent()
- Indicates if the abort reason parameter is present in this Event.
- Returns:
- true if abort reason has been set.
getAbortReason
public int getAbortReason()
throws ParameterNotSetException
- Gets the abort reason parameter of the UserAbort request primitive.
Abort Reason indicates whether a dialogue is aborted because the received
application context name is not supported and no alternative one can be
proposed (abort reason = application context not supported) or because of
any other user problem (abort reason = user specific).
- Returns:
- either TC_ACN_NOT_SUPPORTED or TC_USER_SPECIFIC
- Throws:
- ParameterNotSetException - this exception is thrown if this
parameter has not yet been set
setAbortReason
public void setAbortReason(int abortReason)
- Sets the Abort Reason parameter of the UserAbort request primitive.
Abort Reason indicates whether a dialogue is aborted because the received
application context name is not supported and no alternative one can be
proposed (abort reason = application context not supported) or because of
any other user problem (abort reason = user specific).
- Parameters:
abortRsn
- the Abort Reason of the UserAbortReqEvent.
This may be either TC_ACN_NOT_SUPPORTED or TC_USER_SPECIFIC
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