jain.protocol.ss7.tcap
Class DialogueReqEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

BeginReqEvent, ContinueReqEvent, EndReqEvent, UnidirectionalReqEvent, UserAbortReqEvent

public abstract class DialogueReqEvent

extends java.util.EventObject

implements java.io.Serializable, java.lang.Cloneable

A DialogueReqEvent is the superclass of all Dialogue Request primitives, which represent TCAP Dialogue Requests sent from a JainTcapProvider to a JainTcapListener . It affords a method of generic event passing, while enforcing tight control over event flow between the Listener and the Provider. This type of Event will be processed by the processDialogueIndEvent method of the JainTcapListener . This class implements the java.lang.Cloneable interface, therefore all Dialogue Request primitives that extend this Event can be cloned using the clone() method inherited from java.lang.Object .

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

Serialized Form

Field Summary

protected int	m_dialogueId The Dialogue Id parameter.
protected boolean	m_dialogueIdPresent
protected DialoguePortion	m_dialoguePortion The Dialogue Portion of this Dialogue handling request primitive.
protected boolean	m_dialoguePortionPresent
protected byte	m_qualityOfService The Quality of Service parameter for Dialogue Request Events.
protected boolean	m_qualityOfServicePresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

DialogueReqEvent(java.lang.Object source)
Constructs a new DialogueReqEvent.

Method Summary

int	getDialogueId() Gets the Dialogue Id parameter, which is a reference identifier that is used to uniquely identify a dialogue and all associated transaction messages and components with that Dialogue.
DialoguePortion	getDialoguePortion() Gets the Dialogue Portion of this Dialogue handling request primitive.
abstract int	getPrimitiveType() This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Dialogue Request primitive.
byte	getQualityOfService() Gets the Quality of Service parameter of this Dialogue Requeat event.
boolean	isDialoguePortionPresent() Indicates if the Dialogue Portion parameter is present in this Event.
boolean	isQualityOfServicePresent() Indicates if the Quality of Service is present in this Event.
void	setDialogueId(int dialogueId) Sets the Dialogue Id parameter, of this Dialogue Request Event, which is a reference identifier that is used to uniquely identify a dialogue and all associated transaction messages and components with that Dialogue.
void	setDialoguePortion(DialoguePortion dialoguePortion) Sets the Dialogue Portion of this Dialogue handling request primitive.
void	setQualityOfService(byte qualityOfService) Sets the Quality of Service of this Dialogue Request Event, the Quality of Service parameter is initialized to zero, therefore by default can be interpreted as "Not Used".
void	setSource(java.lang.Object source) Sets the source of this event.
java.lang.String	toString() String representation of class DialogueReqEvent

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

Field Detail

m_dialogueId

protected int m_dialogueId

The Dialogue Id parameter.

m_dialogueIdPresent

protected boolean m_dialogueIdPresent

m_qualityOfService

protected byte m_qualityOfService

The Quality of Service parameter for Dialogue Request Events.

m_qualityOfServicePresent

protected boolean m_qualityOfServicePresent

m_dialoguePortion

protected DialoguePortion m_dialoguePortion

The Dialogue Portion of this Dialogue handling request primitive.

m_dialoguePortionPresent

protected boolean m_dialoguePortionPresent

Constructor Detail

DialogueReqEvent

public DialogueReqEvent(java.lang.Object source)

Constructs a new DialogueReqEvent.

Parameters:

source - the Object Source supplied to the constructor

Method Detail

setSource

public void setSource(java.lang.Object source)

Sets the source of this event. This method may be used to overirde the setting of the event source through the constructor, this provides the ability to clone the Event and change the Event source at any time.

Parameters:

source - The new Object Source

setDialogueId

public void setDialogueId(int dialogueId)

Sets the Dialogue Id parameter, of this Dialogue Request Event, which is a reference identifier that is used to uniquely identify a dialogue and all associated transaction messages and components with that Dialogue. It is determined by the local TCAP layer and given to the application for all transactions received or initiated by the local application.

Note to developers :- If this is the first BEGIN transaction message of a new dialogue a call should be made to the getNewDialogueID method of the JainTcapProvider in order to get returned a free Dialogue Id from the underlying stack implementation.

Parameters:

dialogueId - The new Dialogue Identifier

setDialoguePortion

public void setDialoguePortion(DialoguePortion dialoguePortion)

Sets the Dialogue Portion of this Dialogue handling request primitive. The Dialogue Portion provides a mechanism to determine the interpretation of TCAP message information, security and confidentiality at a remote TCAP. A Dialogue Portion is forbidden in an ANSI 1992 implementation of the JAIN TCAP API.

Parameters:

dialoguePortion - The new Dialogue Portion

setQualityOfService

public void setQualityOfService(byte qualityOfService)

Sets the Quality of Service of this Dialogue Request Event, the Quality of Service parameter is initialized to zero, therefore by default can be interpreted as "Not Used".

Parameters:

qualityOfService - The new QualityOfService value

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException

Gets the Dialogue Id parameter, which is a reference identifier that is used to uniquely identify a dialogue and all associated transaction messages and components with that Dialogue. It is determined by the local TCAP layer and given to the application for all transactions received or initiated by the local application.

Returns:

the dialogueId that uniquely identifies the Dialogue of this Dialogue Request Event.

Throws:

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

isDialoguePortionPresent

public boolean isDialoguePortionPresent()

Indicates if the Dialogue Portion parameter is present in this Event.

Note to developers :- A Dialogue Portion can only be present in an ITU 1993, ITU 1997 and ANSI 1996 implementation of the JAIN TCAP API.

Returns:

true if Dialogue Portion has been set, false otherwise.

getDialoguePortion

public DialoguePortion getDialoguePortion()
                                   throws ParameterNotSetException

Gets the Dialogue Portion of this Dialogue handling request primitive. The Dialogue Portion provides a mechanism to determine the interpretation of TCAP message information, security and confidentiality at a remote TCAP. A Dialogue Portion is forbidden in a ANSI 1992 implementaion of the JAIN TCAP API.

Returns:

the dialoguePortion of this Dialogue handling request primitive.

Throws:

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

isQualityOfServicePresent

public boolean isQualityOfServicePresent()

Indicates if the Quality of Service 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 this Dialogue Requeat event. Quality of Service is an SCCP parameter that is required from the application.

Returns:

the qualityOfService parameter of the Event.

Throws:

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

getPrimitiveType

public abstract int getPrimitiveType()

This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Dialogue Request primitive.

Returns:

The Primitive Type of the Event

toString

public java.lang.String toString()

String representation of class DialogueReqEvent

Overrides:

toString in class java.util.EventObject

Returns:

String provides description of class DialogueReqEvent