jain.protocol.ss7.tcap.dialogue
Class UnidirectionalIndEvent

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

public final class UnidirectionalIndEvent
extends DialogueIndEvent

An event representing a TCAP Unidirectional indication dialogue primitive. This event will be passed from the Provider (TCAP) to the Listener(the TC User) to indicate the receipt of a TCAP message from an Unstructured dialogue (a dialogue between two TC Users with no explicit association between them).
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. A Uni Indication event is the only Dialogue Indication Event that does not use a Dialogue Id within the supported variants. However for the JAIN TCAP API specification the Dialogue Id will be included to associate Component Events with this Dialogue Event, hence simplifing the implementation of a JAIN TCAP application.

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Constructor Summary
UnidirectionalIndEvent(java.lang.Object source, TcapUserAddress originAddress, TcapUserAddress destAddress, boolean componentsPresent)
          Constructs a new UnidirectionalIndEvent, 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 and resets the 'Components Present' flag to false.
 TcapUserAddress getDestinationAddress()
          Gets the Destination Address parameter of the Unidirectional indication primtive.
 TcapUserAddress getOriginatingAddress()
          Gets the Originating Address parameter of the Unidirectional indication primitive.
 int getPrimitiveType()
          This method returns the type of this primitive.
 byte getQualityOfService()
          Gets the Quality of Service parameter of the Unidirectional indication primitive.
 boolean isComponentsPresent()
          Reteurns the Components present flag of this Unidirectional indication primitive.
 boolean isDialogueIdPresent()
          Indicates if the Dialogue Id is present in this Event.
 boolean isQualityOfServicePresent()
          Indicates if the Quality of Service parameter is present in this Event.
 void setComponentsPresent(boolean componentsPresent)
          Sets the Components present parameter of this Unidirectional indication primitive.
 void setDestinationAddress(TcapUserAddress destination)
          Sets the Destination Address parameter of the Unidirectional indication primitive.
 void setOriginatingAddress(TcapUserAddress origin)
          Sets the Originating Address parameter of the Unidirectional indication primitive.
 void setQualityOfService(byte qualityOfService)
          Sets the Quality of Service parameter of the Unidirectional 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

UnidirectionalIndEvent

public UnidirectionalIndEvent(java.lang.Object source,
                              TcapUserAddress originAddress,
                              TcapUserAddress destAddress,
                              boolean componentsPresent)
Constructs a new UnidirectionalIndEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.
Method Detail

isDialogueIdPresent

public boolean isDialogueIdPresent()
Indicates if the Dialogue Id is present in this Event.
Returns:
true if Dialogue Id has been set.

getDestinationAddress

public TcapUserAddress getDestinationAddress()
                                      throws MandatoryParameterNotSetException
Gets the Destination Address parameter of the Unidirectional indication primtive. Destination Address is an SCCP parameter that is required from the application.
Returns:
the TcapUserAddress representing the Destination Address of the Unidirectional indication primtive.
Throws:
MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not yet been set

setDestinationAddress

public void setDestinationAddress(TcapUserAddress destination)
Sets the Destination Address parameter of the Unidirectional indication primitive.
Parameters:
dest - the TcapUserAddress representing the Destination Address of UnidirectionalEvent

getOriginatingAddress

public TcapUserAddress getOriginatingAddress()
                                      throws MandatoryParameterNotSetException
Gets the Originating Address parameter of the Unidirectional indication primitive. Origination Address is an SCCP parameter that is required from the application.
Returns:
the TcapUserAddress represnting the Originating Address of the UnidirectionalEvent.
Throws:
MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not yet been set

setOriginatingAddress

public void setOriginatingAddress(TcapUserAddress origin)
Sets the Originating Address parameter of the Unidirectional indication primitive.
Parameters:
origin - the TcapUserAddress representing the Originating Address of the UnidirectionalEvent.

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 Unidirectional indication primitive. Quality of Service is an SCCP parameter that is required from the application.
Returns:
the Quality of Service parameter of the UnidirectionalEvent
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 Unidirectional indication primitive.
Parameters:
qos - the Quality of Service parameter of the UnidirectionalEvent

setComponentsPresent

public void setComponentsPresent(boolean componentsPresent)
Sets the Components present parameter of this Unidirectional indication primitive. This flag is used to determine if their are any components associated with this primitive. This flag will be reset to false when the clearAllParameters() method is invoked.
Parameters:
componentsPresent - the Components Present of the UnidirectionalEvent.

isComponentsPresent

public boolean isComponentsPresent()
Reteurns the Components present flag of this Unidirectional indication primitive. This flag is used to determine if their are any components associated with this primitive. This flag will be reset to false when the clearAllParameters() method is invoked.
Returns:
the Components Present of the UnidirectionalEvent.

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 and resets the 'Components Present' flag to false.

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