|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.EventObject | +--jain.protocol.ss7.tcap.DialogueIndEvent | +--jain.protocol.ss7.tcap.dialogue.BeginIndEvent
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.
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 |
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public BeginIndEvent(java.lang.Object source, int dialogueId, TcapUserAddress originAddress, TcapUserAddress destAddress, boolean componentsPresent)
Method Detail |
public TcapUserAddress getDestinationAddress() throws MandatoryParameterNotSetException
public void setDestinationAddress(TcapUserAddress destination)
dest
- the TcapUserAddress representing the Destination Address of
BeginEventpublic TcapUserAddress getOriginatingAddress() throws MandatoryParameterNotSetException
public void setOriginatingAddress(TcapUserAddress origin)
origin
- the TcapUserAddress representing the
Originating Address of the BeginEvent.public boolean isQualityOfServicePresent()
public byte getQualityOfService() throws ParameterNotSetException
public void setQualityOfService(byte qualityOfService)
qos
- the Quality of Service parameter of the BeginEventpublic boolean isAllowedPermissionPresent()
public boolean isAllowedPermission() throws ParameterNotSetException
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.
public void setAllowedPermission(boolean allowedPermission)
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.
allowedPermission
- whether permission has been granted. This may be either:
public void setComponentsPresent(boolean componentsPresent)
componentsPresent
- the Components Present of the BeginEvent.public boolean isComponentsPresent()
public int getPrimitiveType()
public void clearAllParameters()
public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |