jain.protocol.ss7.tcap.dialogue
Class BeginReqEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class BeginReqEvent

extends DialogueReqEvent

An event representing a TCAP Begin 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. This primitive is used to establish a transaction with the destination 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:

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

BeginReqEvent(java.lang.Object source, int dialogueId, SccpUserAddress originAddress, SccpUserAddress destAddress)
Constructs a new BeginReqEvent, 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 Begin request primtive.
SccpUserAddress	getOriginatingAddress() Gets the Originating Address parameter of the Begin request primitive.
int	getPrimitiveType() This method returns the type of this 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.
void	setAllowedPermission(boolean allowedPermission) Sets the Allowed Permission parameter of the Begin dialogue primitive.
void	setDestinationAddress(SccpUserAddress destination) Sets the Destination Address parameter of the Begin Request primitive.
void	setOriginatingAddress(SccpUserAddress origin) Sets the Originating Address parameter of the Begin Request primitive.
java.lang.String	toString() String representation of class BeginReqEvent

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

BeginReqEvent

public BeginReqEvent(java.lang.Object source,
                     int dialogueId,
                     SccpUserAddress originAddress,
                     SccpUserAddress destAddress)

Constructs a new BeginReqEvent, 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 Desstination Address supplied to the constructor

Method Detail

setDestinationAddress

public void setDestinationAddress(SccpUserAddress destination)

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

setAllowedPermission

public void setAllowedPermission(boolean allowedPermission)

Sets the Allowed Permission parameter of the Begin dialogue primitive. The Allowed Permission parameter indicates whether or not permission is to be granted to the remote TC-User to terminate this dialogue.

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

Permission should be granted when the converse applies.

Note to developers: Permission to end (release) a transaction is an ANSI concept only.

Parameters:

allowedPermission - The new Allowed Permission Flag

getDestinationAddress

public SccpUserAddress getDestinationAddress()
                                      throws MandatoryParameterNotSetException

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

Throws:

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

getOriginatingAddress

public SccpUserAddress getOriginatingAddress()
                                      throws MandatoryParameterNotSetException

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

Throws:

MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not 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 is to be granted to the remote TC-User to terminate this dialogue.

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

Permission should be granted when the converse applies.

NOTE: permission to end (release) a transaction is an ANSI concept only.

Returns:

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

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

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not 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 BeginReqEvent

Overrides:

toString in class DialogueReqEvent

Returns:

String provides description of class BeginReqEvent