jain.protocol.ss7.tcap.dialogue
Class ProviderAbortIndEvent

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

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 transactio sublayer) in mreaction 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.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

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) parameter of the ProviderAbort indication primitive.
 void setQualityOfService(byte qualityOfService)
          Sets the Quality of Service parameter of the ProviderAbort 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

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

setQualityOfService

public void setQualityOfService(byte qualityOfService)
Sets the Quality of Service parameter of the ProviderAbort indication primitive.
Parameters:
qos - the Quality of Service parameter of the ProviderAbortEvent

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_BADLY_FORMATTED_TRANSACTION_PORTION
        P_ABORT_INCORRECT_TRANSACTION_PORTION
          P_ABORT_RESOURCE_LIMIT
            P_ABORT_UNRCGNZ_MSG_TYPE

setPAbort

public void setPAbort(int pAbort)
Sets 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.
Parameters:
pAbort - one of the Provider Abort constants:
  • DialogueConstants.P_ABORT_ABNORMAL_DIALOGUE
  • DialogueConstants.P_ABORT_BADLY_FORMATTED_TRANSACTION_PORTION
  • DialogueConstants.P_ABORT_INCORRECT_TRANSACTION_PORTION
  • DialogueConstants.P_ABORT_RESOURCE_LIMIT
  • DialogueConstants.P_ABORT_UNRCGNZ_MSG_TYPE
  • DialogueConstants.P_ABORT_UNRECOGNIZED_TRANSACTION_ID

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


28 June 2000
If you have any comments or queries, please mail them to JainTcapApiFeedback@AePONA.Com

Copyright - 2000 Sun Microsystems