jain.protocol.ss7.tcap.dialogue
Class ProviderAbortIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class ProviderAbortIndEvent

extends DialogueIndEvent

An event representing a TCAP ProviderAbort indication dialogue primitive. This event will be passed from the Provider (TCAP) to the Listener(the TC User) to inform the Tc User that the dialogue has been terminated by the service provider (the transaction sublayer) in reaction to a transaction abort by the transaction sublayer. Any pending components are not transmitted.
The mandatory parameters of this primitive are supplied to the constructor. Optional parameters may then be set using the set methods.

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

ProviderAbortIndEvent(java.lang.Object source, int dialogueId, int pAbort)
Constructs a new ProviderAbortIndEvent, 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	getPAbort() Gets the Provider Abort (pAbort) parameter of the ProviderAbort indication primitive.
int	getPrimitiveType() This method returns the type of this primitive.
byte	getQualityOfService() Gets the Quality of Service parameter of the ProviderAbort indication primitive.
boolean	isQualityOfServicePresent() Indicates if the Quality of Service parameter is present in this Event.
void	setPAbort(int pAbort) Sets the Provider Abort (pAbort) cause of the ProviderAbort indication primitive.
void	setQualityOfService(byte qualityOfService) Sets the Quality of Service parameter of the ProviderAbort indication primitive.
java.lang.String	toString() String representation of class ProviderAbortIndEvent

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

ProviderAbortIndEvent

public ProviderAbortIndEvent(java.lang.Object source,
                             int dialogueId,
                             int pAbort)

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

pAbort - the PAbort Cause supplied to the constructor

Method Detail

setQualityOfService

public void setQualityOfService(byte qualityOfService)

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

Parameters:

qualityOfService - The new Quality Of Service value

setPAbort

public void setPAbort(int pAbort)

Sets the Provider Abort (pAbort) cause of the ProviderAbort indication primitive. The PAbort parameter contains information indicating the reason that the TCAP layer aborted a dialogue.

Parameters:

pAbort - one of the following:

• P_ABORT_UNRCGNZ_MSG_TYPE
• P_ABORT_UNRECOGNIZED_TRANSACTION_ID
• P_ABORT_BADLY_FORMATTED_TRANSACTION_PORTION
• P_ABORT_INCORRECT_TRANSACTION_PORTION
• P_ABORT_RESOURCE_LIMIT
• P_ABORT_ABNORMAL_DIALOGUE
• P_ABORT_UNRECOG_DIALOGUE_PORTION_ID(ANSI ONLY)
• P_ABORT_BADLY_STRUCTURED_DIALOGUE_PORTION(ANSI ONLY)
• P_ABORT_MISSING_DIALOGUE_PORTION(ANSI ONLY)
• P_ABORT_INCONSISTENT_DIALOGUE_PORTION(ANSI ONLY)
• P_ABORT_PERMISSION_TO_RELEASE_PROBLEM(ANSI ONLY)

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

Returns:

the Quality of Service parameter of the ProviderAbortEvent

Throws:

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

getPAbort

public int getPAbort()
              throws MandatoryParameterNotSetException

Gets the Provider Abort (pAbort) parameter of the ProviderAbort indication primitive. The PAbort parameter contains information indicating the reason that the TCAP layer aborted a dialogue.

Returns:

one of the following:

• P_ABORT_UNRCGNZ_MSG_TYPE
• P_ABORT_UNRECOGNIZED_TRANSACTION_ID
• P_ABORT_BADLY_FORMATTED_TRANSACTION_PORTION
• P_ABORT_INCORRECT_TRANSACTION_PORTION
• P_ABORT_RESOURCE_LIMIT
• P_ABORT_ABNORMAL_DIALOGUE
• P_ABORT_UNRECOG_DIALOGUE_PORTION_ID(ANSI ONLY)
• P_ABORT_BADLY_STRUCTURED_DIALOGUE_PORTION(ANSI ONLY)
• P_ABORT_MISSING_DIALOGUE_PORTION(ANSI ONLY)
• P_ABORT_INCONSISTENT_DIALOGUE_PORTION(ANSI ONLY)
• P_ABORT_PERMISSION_TO_RELEASE_PROBLEM(ANSI ONLY)

Throws:

MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not been set

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueIndEvent

Returns:

The Primitive Type of the Event

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters .

toString

public java.lang.String toString()

String representation of class ProviderAbortIndEvent

Overrides:

toString in class DialogueIndEvent

Returns:

String provides description of class ProviderAbortIndEvent