jain.protocol.ss7.tcap.dialogue
Class UserAbortIndEvent

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

public final class UserAbortIndEvent

extends DialogueIndEvent

An event representing a TCAP UserAbort indication dialogue primitive. This event will be passed from the Provider (TCAP) to the Listener(the TC User) to indicate the abrupt termination of a dialogue.
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

Constructor Summary

UserAbortIndEvent(java.lang.Object source, int dialogueId)
Constructs a new UserAbortIndEvent, 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 indication primitive.
int	getPrimitiveType() This method returns the type of this primitive.
byte	getQualityOfService() Gets the Quality of Service parameter of the UserAbort indication primitive.
byte[]	getUserAbortInformation() Gets the User Abort Information parameter of the UserAbort indication primitive.
boolean	isAbortReasonPresent() Indicates if the abort reason parameter is present in this Event.
boolean	isQualityOfServicePresent() Indicates if the Quality of Service 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 indication primitive.
void	setQualityOfService(byte qualityOfService) Sets the Quality of Service parameter of the UserAbort indication primitive.
void	setUserAbortInformation(byte[] userAbortInformation) Sets the User Abort Information parameter of the UserAbort indication primitive.
java.lang.String	toString() Returns a string representation of an instance of this class.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserAbortIndEvent

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

Constructs a new UserAbortIndEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.

Method Detail

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 UserAbort indication primitive. Quality of Service is an SCCP parameter that is required from the application.

Returns:

the Quality of Service parameter of the UserAbortEvent

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 UserAbort indication primitive.

Parameters:

qos - the Quality of Service parameter of the UserAbortEvent

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 indication 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 indication 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 indication 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

• ABORT_REASON_ACN_NOT_SUPPORTED
• ABORT_REASON_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 indication 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 UserAbortIndEvent. This may be either:

• DialogueConstants.ABORT_REASON_ACN_NOT_SUPPORTED
• DialogueConstants.ABORT_REASON_USER_SPECIFIC

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueIndEvent

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