jain.protocol.ss7.tcap
Class DialogueIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

BeginIndEvent, ContinueIndEvent, EndIndEvent, NoticeIndEvent, ProviderAbortIndEvent, UnidirectionalIndEvent, UserAbortIndEvent

public abstract class DialogueIndEvent

extends java.util.EventObject

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

A DialogueIndEvent is the superclass of all Dialogue Indication primitives, which represent TCAP Dialogue Indications 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 Indication 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, which uniquely identifies this Dialogue Indication Event to a specific Dialogue between two TCAP Users.
protected boolean	m_dialogueIdPresent
protected DialoguePortion	m_dialoguePortion The Dialogue Portion of this Dialogue handling indication primitive, which is forbidden in an ANSI 1992 implementation of the JAIN TCAP API.
protected boolean	m_dialoguePortionPresent Should always be false in an ANSI 1992 implementation of the JAIN TCAP API.

Fields inherited from class java.util.EventObject

source

Constructor Summary

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

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 indication 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 Indication primitive.
boolean	isDialoguePortionPresent() Indicates if the Dialogue Portion parameter is present in this Event.
void	setDialogueId(int dialogueId) Sets the Dialogue Id parameter of this Dialogue Indication 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 indication primitive.
void	setSource(java.lang.Object source) Sets the source of this event.
java.lang.String	toString() String representation of class DialogueIndEvent

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, which uniquely identifies this Dialogue Indication Event to a specific Dialogue between two TCAP Users.

m_dialogueIdPresent

protected boolean m_dialogueIdPresent

m_dialoguePortion

protected DialoguePortion m_dialoguePortion

The Dialogue Portion of this Dialogue handling indication primitive, which is forbidden in an ANSI 1992 implementation of the JAIN TCAP API.

m_dialoguePortionPresent

protected boolean m_dialoguePortionPresent

Should always be false in an ANSI 1992 implementation of the JAIN TCAP API.

Constructor Detail

DialogueIndEvent

public DialogueIndEvent(java.lang.Object source)

Constructs a new DialogueIndEvent.

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 override the setting 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 Indication 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 :- A Dialogue Id is forbidden in a UNI Indication message, therefore this method should not be used in a UnidirectionalInd Event.

Parameters:

dialogueId - The new Dialogue Identifier

setDialoguePortion

public void setDialoguePortion(DialoguePortion dialoguePortion)

Sets the Dialogue Portion of this Dialogue handling indication 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

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.

Note to developers :- A Dialogue Id is forbidden in a UNI Indication message, therefore this method should not be used in a UnidirectionalInd Event.

Returns:

the dialogueId that uniquely identifies the Dialogue of this Dialogue Indication 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 indication 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 indication primitive.

Throws:

ParameterNotSetException - this exception is thrown if this Optional JAIN parameter has not 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 Indication primitive.

Returns:

The Primitive Type of the Event

toString

public java.lang.String toString()

String representation of class DialogueIndEvent

Overrides:

toString in class java.util.EventObject

Returns:

String provides description of class DialogueIndEvent