jain.protocol.ss7.tcap.dialogue
Class BeginReqEvent

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

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

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Fields inherited from class jain.protocol.ss7.tcap.DialogueReqEvent
dialogueId, dialogueIdPresent, dialoguePortion, dialoguePortionPresent, qualityOfService, qualityOfServicePresent
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
BeginReqEvent(java.lang.Object source, int dialogueId, TcapUserAddress originAddress, TcapUserAddress 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 .
 TcapUserAddress getDestinationAddress()
          Gets the Destination Address parameter of the Begin request primtive.
 TcapUserAddress 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(TcapUserAddress destination)
          Sets the Destination Address parameter of the Begin request primitive.
 void setOriginatingAddress(TcapUserAddress origin)
          Sets the Originating Address parameter of the Begin request primitive.
 java.lang.String toString()
          Returns a string representation of an instance of this class.
 
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,
                     TcapUserAddress originAddress,
                     TcapUserAddress destAddress)
Constructs a new BeginReqEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.
Method Detail

getDestinationAddress

public TcapUserAddress getDestinationAddress()
                                      throws ParameterNotSetException
Gets the Destination Address parameter of the Begin request primtive. Destination Address is an SCCP parameter that is required from the application.
Returns:
the TcapUserAddress representing the Destination Address of the Begin request primtive.
Throws:
ParameterNotSetException - this exception is thrown if this Mandatory parameter has not yet been set

setDestinationAddress

public void setDestinationAddress(TcapUserAddress destination)
Sets the Destination Address parameter of the Begin request primitive.
Parameters:
dest - the TcapUserAddress representing the Destination Address of BeginEvent

getOriginatingAddress

public TcapUserAddress getOriginatingAddress()
                                      throws ParameterNotSetException
Gets the Originating Address parameter of the Begin request primitive. Origination Address is an SCCP parameter that is required from the application.
Returns:
the TcapUserAddress represnting the Originating Address of the BeginEvent.
Throws:
ParameterNotSetException - this exception is thrown if this Mandatory parameter has not yet been set

setOriginatingAddress

public void setOriginatingAddress(TcapUserAddress origin)
Sets the Originating Address parameter of the Begin request primitive.
Parameters:
origin - the TcapUserAddress representing the Originating Address of the BeginEvent.

isAllowedPermissionPresent

public boolean isAllowedPermissionPresent()
Indicates if the Allowed Permission parameter is present in this Event.
Returns:
true if Allowed Permission Id has been set.

isAllowedPermission

public boolean isAllowedPermission()
                            throws ParameterNotSetException
Gets the Allowed Permission parameter of the Begin dialogue primitive. The Allowed Permission parameter indicates wheter 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 yet been set

setAllowedPermission

public void setAllowedPermission(boolean allowedPermission)
Sets the Allowed Permission parameter of the Begin dialogue primitive. The Allowed Permission parameter indicates wheter 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.

Parameters:
allowedPermission - whetner permission should be 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

getPrimitiveType

public int getPrimitiveType()
This method returns the type of this primitive.
Overrides:
getPrimitiveType in class DialogueReqEvent

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters .

toString

public java.lang.String toString()
Returns a string representation of an instance of this class.
Overrides:
toString in class java.util.EventObject


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems