jain.protocol.ss7.tcap.dialogue
Class BeginIndEvent

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

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 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.DialogueIndEvent
dialogueId, dialogueIdPresent, dialoguePortion, dialoguePortionPresent
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
BeginIndEvent(java.lang.Object source, int dialogueId, TcapUserAddress originAddress, TcapUserAddress 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.
 TcapUserAddress getDestinationAddress()
          Gets the Destination Address parameter of the Begin indication primtive.
 TcapUserAddress getOriginatingAddress()
          Gets the Originating Address parameter of the Begin indication primitive.
 int getPrimitiveType()
          This method returns the type of this primitive, the primitive tyoe 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)
          Sets the Allowed Permission parameter of the Begin dialogue primitive.
 void setComponentsPresent(boolean componentsPresent)
          Sets the Components present parameter of this Begin indication primitive.
 void setDestinationAddress(TcapUserAddress destination)
          Sets the Destination Address parameter of the Begin indication primitive.
 void setOriginatingAddress(TcapUserAddress 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()
          Returns a string representation of an instance of this class.
 
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,
                     TcapUserAddress originAddress,
                     TcapUserAddress destAddress,
                     boolean componentsPresent)
Constructs a new BeginIndEvent, 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 indication primtive. Destination Address is an SCCP parameter that is required from the application.
Returns:
the TcapUserAddress representing the Destination Address of the Begin indication 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 indication primitive. Destination Address is an SCCP parameter that is required from the application.
Parameters:
dest - the TcapUserAddress representing the Destination Address of BeginEvent

getOriginatingAddress

public TcapUserAddress getOriginatingAddress()
                                      throws ParameterNotSetException
Gets the Originating Address parameter of the Begin indication 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 indication primitive. Origination Address is an SCCP parameter that is required from the application.
Parameters:
origin - the TcapUserAddress representing the Originating Address of the BeginEvent.

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.

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

setQualityOfService

public void setQualityOfService(byte qualityOfService)
Sets the Quality of Service parameter of the Begin indication primitive.
Parameters:
qos - the Quality of Service parameter 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 whether or not permission has been granted to the receiving TC-User by the sending TC-User, to terminate this dialogue.

Permission should nothave 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

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 has been granted to the receiving TC-User by the sending TC-User to terminate this dialogue.

Permission should nothave 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.

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

Parameters:
allowedPermission - whether permission 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

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 Components Present of the BeginEvent.

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 tyoe constants are defined with the JainTcapProvider.
Overrides:
getPrimitiveType in class DialogueIndEvent

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters and resets the 'Components Present' flag to false.

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