jain.protocol.ss7.tcap.dialogue
Class UnidirectionalReqEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

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 parameters 'Application Context Name' and 'User Information' are centrally located in the Dialogue Portion class, therefore to manipulate them it is necessary to instantiate the Dialogue Portion Object and use the accessors method for the two parameters in that Dialogue Portion Object.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

DialogueReqEvent, Serialized Form

Fields inherited from class jain.protocol.ss7.tcap.DialogueReqEvent

m_dialogueId, m_dialogueIdPresent, m_dialoguePortion, m_dialoguePortionPresent, m_qualityOfService, m_qualityOfServicePresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

UnidirectionalReqEvent(java.lang.Object source, SccpUserAddress originAddress, SccpUserAddress 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 .
SccpUserAddress	getDestinationAddress() Gets the Destination Address parameter of the Unidirectional request primtive.
SccpUserAddress	getOriginatingAddress() Gets the Originating Address parameter of the Unidirectional request primitive.
int	getPrimitiveType() This method returns the type of this primitive.
boolean	isDialogueIdPresent() Deprecated. As of JAIN TCAP v1.1. No replacement. The dialogueId parameter is mandatory in all Dialogue Request events.
void	setDestinationAddress(SccpUserAddress destination) Sets the Destination Address parameter of the Unidirectional Request primitive.
void	setOriginatingAddress(SccpUserAddress origin) Sets the Originating Address parameter of the Unidirectional Request primitive.
java.lang.String	toString() String representation of class UnidirectionalReqEvent

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,
                              SccpUserAddress originAddress,
                              SccpUserAddress destAddress)

Constructs a new UnidirectionalReqEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor. Within this method TcapUserAddress has been changed to SccpUserAddress. The method has not been deprecated as a new method using type SccpUserAddress would have to be created with a different method name. This is less desirable than the effective removal of the old method.

Parameters:

source - the Event Source supplied to the constructor

originAddress - the Originating Address supplied to the constructor

destAddress - the Destination Address supplied to the constructor

Method Detail

setDestinationAddress

public void setDestinationAddress(SccpUserAddress destination)

Sets the Destination Address parameter of the Unidirectional Request primitive. Destination Address is an SCCP parameter that is required from the application. Within this method TcapUserAddress has been changed to SccpUserAddress. The method has not been deprecated as a new method using type SccpUserAddress would have to be created with a different method name. This is less desirable than the effective removal of the old method.

Parameters:

destination - The new Destination Address value

setOriginatingAddress

public void setOriginatingAddress(SccpUserAddress origin)

Sets the Originating Address parameter of the Unidirectional Request primitive. Origination Address is an SCCP parameter that is required from the application. Within this method TcapUserAddress has been changed to SccpUserAddress. The method has not been deprecated as a new method using type SccpUserAddress would have to be created with a different method name. This is less desirable than the effective removal of the old method.

Parameters:

origin - The new Originating Address value

isDialogueIdPresent

public boolean isDialogueIdPresent()

Deprecated. As of JAIN TCAP v1.1. No replacement. The dialogueId parameter is mandatory in all Dialogue Request events.

getDestinationAddress

public SccpUserAddress getDestinationAddress()
                                      throws MandatoryParameterNotSetException

Gets the Destination Address parameter of the Unidirectional request primtive. Destination Address is an SCCP parameter that is required from the application. The return type of this get method has been changed from TcapUserAddress. The TcapUserAddress class has been deprecated in this release (V1.1). This method has not been deprecated as it's replacement would then have to have a different name.

Returns:

the SccpUserAddress representing the Destination Address of the Unidirectional request primtive.

Throws:

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

getOriginatingAddress

public SccpUserAddress getOriginatingAddress()
                                      throws MandatoryParameterNotSetException

Gets the Originating Address parameter of the Unidirectional request primitive. Origination Address is an SCCP parameter that is required from the application. The return type of this get method has been changed from TcapUserAddress. The TcapUserAddress class has been deprecated in this release (V1.1). This method has not been deprecated as it's replacement would then have to have a different name.

Returns:

the SccpUserAddress represnting the Originating Address of the UnidirectionalEvent.

Throws:

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

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueReqEvent

Returns:

The Primitive Type of this Event

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters .

toString

public java.lang.String toString()

String representation of class UnidirectionalReqEvent

Overrides:

toString in class DialogueReqEvent

Returns:

String provides description of class UnidirectionalReqEvent