jain.protocol.ss7.tcap.dialogue
Class NoticeIndEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class NoticeIndEvent

extends DialogueIndEvent

An event representing a TCAP Notice indication dialogue primitive. This event will be passed from the Provider (TCAP) to the Listener(the TC User) to indicate that the Network Service Provider has been unable to provide the requested service.
The mandatory parameters of this primitive are supplied to the constructor. Optional parameters may then be set using the set methods.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

DialogueIndEvent, 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

NoticeIndEvent(java.lang.Object source, int dialogueId, byte[] reportCause)
Constructs a new NoticeIndEvent, 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 Notice indication primtive.
SccpUserAddress	getOriginatingAddress() Gets the Originating Address parameter of the Notice indication primitive.
int	getPrimitiveType() This method returns the type of this primitive.
byte[]	getReportCause() Gets the Report Cause parameter of this Notice indication primitive.
boolean	isDestinationAddressPresent() Indicates if the Destination Address parameter is present in this Event.
boolean	isOriginatingAddressPresent() Indicates if the Originating Address parameter is present in this Event.
boolean	isReportCausePresent() Indicates if the Report Cause parameter is present in this Event.
void	setDestinationAddress(SccpUserAddress destination) Sets the Destination Address parameter of the Notice indication primitive.
void	setOriginatingAddress(SccpUserAddress origin) Sets the Originating Address parameter of the Notice indication primitive.
void	setReportCause(byte[] reportCause) Sets the Report Cause parameter of this Notice indication primitive.
java.lang.String	toString() String representation of class NoticeIndEvent

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

NoticeIndEvent

public NoticeIndEvent(java.lang.Object source,
                      int dialogueId,
                      byte[] reportCause)

Constructs a new NoticeIndEvent, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.

Parameters:

source - the Event Source supplied to the constructor

dialogueId - the Dialogue Identifier supplied to the constructor

reportCause - the Report Cause supplied to the constructor

Method Detail

setDestinationAddress

public void setDestinationAddress(SccpUserAddress destination)

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

setReportCause

public void setReportCause(byte[] reportCause)

Sets the Report Cause parameter of this Notice indication primitive.

Parameters:

reportCause - The new Report Cause value

isDestinationAddressPresent

public boolean isDestinationAddressPresent()

Indicates if the Destination Address parameter is present in this Event.

Returns:

true if Destination Address has been set, false otherwise.

getDestinationAddress

public SccpUserAddress getDestinationAddress()
                                      throws ParameterNotSetException

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

Throws:

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

isOriginatingAddressPresent

public boolean isOriginatingAddressPresent()

Indicates if the Originating Address parameter is present in this Event.

Returns:

true if Originating Address has been set, false otherwise.

getOriginatingAddress

public SccpUserAddress getOriginatingAddress()
                                      throws ParameterNotSetException

Gets the Originating Address parameter of the Notice 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 represnting the Originating Address of the Notice Event.

Throws:

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

isReportCausePresent

public boolean isReportCausePresent()

Indicates if the Report Cause parameter is present in this Event.

Returns:

true if Report Cause has been set, false otherwise.

getReportCause

public byte[] getReportCause()
                      throws ParameterNotSetException

Gets the Report Cause parameter of this Notice indication primitive. Report Cause contains information indicating the reason that the message was returned by the SCCP

Returns:

the report cause of this Notice indication primitive.

Throws:

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

getPrimitiveType

public int getPrimitiveType()

This method returns the type of this primitive.

Overrides:

getPrimitiveType in class DialogueIndEvent

Returns:

The Primitive Type value

clearAllParameters

public void clearAllParameters()

Clears all previously set parameters .

toString

public java.lang.String toString()

String representation of class NoticeIndEvent

Overrides:

toString in class DialogueIndEvent

Returns:

String provides description of class NoticeIndEvent