jain.protocol.ss7.tcap.dialogue
Class BeginIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class BeginIndEvent

extends DialogueIndEvent

An event representing a TCAP Begin indication dialogue primitive. This event will be passed from the Provider (TCAP) to the Listener (the TC User) to indicate the initiation of a structured dialogue with the originating node.
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 acessors method for the two parameters in that Dialogue Portion Object.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

DialogueIndEvent, DialoguePortion, Serialized Form

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

m_dialogueId, m_dialogueIdPresent, m_dialoguePortion, m_dialoguePortionPresent

Fields inherited from class java.util.EventObject

source

Constructor Summary

BeginIndEvent(java.lang.Object source, int dialogueId, SccpUserAddress originAddress, SccpUserAddress destAddress, boolean componentsPresent)
Constructs a new BeginIndEvent, 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.
SccpUserAddress	getDestinationAddress() Gets the Destination Address parameter of the Begin indication primitive.
SccpUserAddress	getOriginatingAddress() Gets the Originating Address parameter of the Begin indication primitive.
int	getPrimitiveType() This method returns the type of this primitive, the primitive type constants are defined with the JainTcapProvider.
byte	getQualityOfService() Gets the Quality of Service parameter of the Begin indication primitive.
boolean	isAllowedPermission() Gets the Allowed Permission parameter of the Begin dialogue primitive.
boolean	isAllowedPermissionPresent() Indicates if the Allowed Permission parameter is present in this Event.
boolean	isComponentsPresent() Returns the Components present flag of this Begin indication primitive.
boolean	isQualityOfServicePresent() Indicates if the Quality of Service parameter is present in this Event.
void	setAllowedPermission(boolean allowedPermission)
void	setComponentsPresent(boolean componentsPresent) Sets the Components present parameter of this Begin indication primitive.
void	setDestinationAddress(SccpUserAddress destination) Sets the Destination Address parameter of the Begin indication primitive.
void	setOriginatingAddress(SccpUserAddress origin) Sets the Originating Address parameter of the Begin indication primitive.
void	setQualityOfService(byte qualityOfService) Sets the Quality of Service parameter of the Begin indication primitive.
java.lang.String	toString() String representation of class BeginIndEvent

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BeginIndEvent

public BeginIndEvent(java.lang.Object source,
                     int dialogueId,
                     SccpUserAddress originAddress,
                     SccpUserAddress destAddress,
                     boolean componentsPresent)

Constructs a new BeginIndEvent, 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

dialogueId - the Dialogue Identifier supplied to the constructor

originAddress - the Originating Address supplied to the constructor

destAddress - the Destination Address supplied to the constructor

componentsPresent - the Components Present Flag supplied to the constructor

Method Detail

setDestinationAddress

public void setDestinationAddress(SccpUserAddress destination)

Sets the Destination Address parameter of the Begin indication 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 Begin indication 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

setQualityOfService

public void setQualityOfService(byte qualityOfService)

Sets the Quality of Service parameter of the Begin indication primitive.

Parameters:

qualityOfService - The new Quality Of Service value

setAllowedPermission

public void setAllowedPermission(boolean allowedPermission)

setComponentsPresent

public void setComponentsPresent(boolean componentsPresent)

Sets the Components present parameter of this Begin 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 new Components Present value

getDestinationAddress

public SccpUserAddress getDestinationAddress()
                                      throws MandatoryParameterNotSetException

Gets the Destination Address parameter of the Begin indication primitive. 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 Begin indication primtive.

Throws:

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

getOriginatingAddress

public SccpUserAddress getOriginatingAddress()
                                      throws MandatoryParameterNotSetException

Gets the Originating Address parameter of the Begin indication 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 representing the Originating Address of the BeginEvent.

Throws:

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

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, false otherwise.

getQualityOfService

public byte getQualityOfService()
                         throws ParameterNotSetException

Gets the Quality of Service parameter of the Begin indication primitive. Quality of Service is an SCCP parameter that is required from the application.

Returns:

the Quality of Service parameter of the BeginEvent

Throws:

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

isAllowedPermissionPresent

public boolean isAllowedPermissionPresent()

Indicates if the Allowed Permission parameter is present in this Event.

Returns:

true if Allowed Permission Flag has been set, false otherwise.

isAllowedPermission

public boolean isAllowedPermission()
                            throws ParameterNotSetException

Gets the Allowed Permission parameter of the Begin dialogue primitive. The Allowed Permission parameter indicates whether or not permission has been granted to the receiving TC-User by the sending TC-User, to terminate this dialogue.

Permission should not have been granted whenever the sending TC-User anticipates sending more components that it would like the receiving TC-User to treat as part of the same transaction.

Permission should have been granted when the converse applies.

Returns:

whether permission to release has been granted. This may be either:

• true if the receiving node has the permission to end the dialogue
• false if the receiving node has not the permission to end the dialogue

Throws:

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

isComponentsPresent

public boolean isComponentsPresent()

Returns the Components present flag of this Begin indication primitive. This flag is used to determine if there 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 BeginEvent.

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive, the primitive type constants are defined with the JainTcapProvider.

Overrides:

getPrimitiveType in class DialogueIndEvent

Returns:

The Primitive Type of this Event

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters and resets the 'Components Present' flag to false.

toString

public java.lang.String toString()

String representation of class BeginIndEvent

Overrides:

toString in class DialogueIndEvent

Returns:

String provides description of class BeginIndEvent