jain.protocol.ss7.tcap.dialogue
Class UnidirectionalReqEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.DialogueReqEvent
              |
              +--jain.protocol.ss7.tcap.dialogue.UnidirectionalReqEvent

public final class UnidirectionalReqEvent
extends DialogueReqEvent

An event representing a TCAP Unidirectional Request dialogue primitive. This event will be passed from the Listener (the TC User) to the Provider (TCAP) to trigger the sending of components to the destination node when no reply is expected.This primitive is used when there is no need to establish a transaction with another peer TC User.
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.

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

Fields inherited from class jain.protocol.ss7.tcap.DialogueReqEvent
dialogueId, dialogueIdPresent, dialoguePortion, dialoguePortionPresent, qualityOfService, qualityOfServicePresent
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
UnidirectionalReqEvent(java.lang.Object source, TcapUserAddress originAddress, TcapUserAddress destAddress)
          Constructs a new UnidirectionalReqEvent, 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 .
 TcapUserAddress getDestinationAddress()
          Gets the Destination Address parameter of the Unidirectional request primtive.
 TcapUserAddress getOriginatingAddress()
          Gets the Originating Address parameter of the Unidirectional request primitive.
 int getPrimitiveType()
          This method returns the type of this primitive.
 boolean isDialogueIdPresent()
          Indicates if the Dialogue Id is present in this Event.
 void setDestinationAddress(TcapUserAddress destination)
          Sets the Destination Address parameter of the Unidirectional request primitive.
 void setOriginatingAddress(TcapUserAddress origin)
          Sets the Originating Address parameter of the Unidirectional request primitive.
 java.lang.String toString()
          Returns a string representation of an instance of this class.
 
Methods inherited from class jain.protocol.ss7.tcap.DialogueReqEvent
getDialogueId, getDialoguePortion, getQualityOfService, isDialoguePortionPresent, isQualityOfServicePresent, setDialogueId, setDialoguePortion, setQualityOfService, 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

UnidirectionalReqEvent

public UnidirectionalReqEvent(java.lang.Object source,
                              TcapUserAddress originAddress,
                              TcapUserAddress destAddress)
Constructs a new UnidirectionalReqEvent, 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 ParameterNotSetException
Gets the Destination Address parameter of the Unidirectional request primtive. Destination Address is an SCCP parameter that is required from the application.
Returns:
the TcapUserAddress representing the Destination Address of the Unidirectional request primtive.
Throws:
ParameterNotSetException - this exception is thrown if this Mandatory parameter has not yet been set

setDestinationAddress

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

getOriginatingAddress

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

setOriginatingAddress

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

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

Copyright - 1999 Sun Microsystems