jain.protocol.ss7.tcap.dialogue
Class NoticeIndEvent

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

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.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

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 .
 TcapUserAddress getDestinationAddress()
          Gets the Destination Address parameter of the Notice indication primtive.
 TcapUserAddress 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(TcapUserAddress destination)
          Sets the Destination Address parameter of the Notice indication primitive.
 void setOriginatingAddress(TcapUserAddress 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()
          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

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.
Method Detail

isDestinationAddressPresent

public boolean isDestinationAddressPresent()
Indicates if the Destination Address parameter is present in this Event.
Returns:
true if Destination Address has been set.

getDestinationAddress

public TcapUserAddress 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.
Returns:
the TcapUserAddress representing the Destination Address of the Notice indication primtive.
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setDestinationAddress

public void setDestinationAddress(TcapUserAddress destination)
Sets the Destination Address parameter of the Notice indication primitive.
Parameters:
dest - the TcapUserAddress representing the Destination Address of NoticeEvent

isOriginatingAddressPresent

public boolean isOriginatingAddressPresent()
Indicates if the Originating Address parameter is present in this Event.
Returns:
true if Originating Address has been set.

getOriginatingAddress

public TcapUserAddress 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.
Returns:
the TcapUserAddress represnting the Originating Address of the NoticeEvent.
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setOriginatingAddress

public void setOriginatingAddress(TcapUserAddress origin)
Sets the Originating Address parameter of the Notice indication primitive.
Parameters:
origin - the TcapUserAddress representing the Originating Address of the NoticeEvent.

setReportCause

public void setReportCause(byte[] reportCause)
Sets the Report Cause parameter of this Notice indication primitive.
Parameters:
cause - the report cause

isReportCausePresent

public boolean isReportCausePresent()
Indicates if the Report Cause parameter is present in this Event.
Returns:
true if Report Cause has been set.

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

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


28 June 2000
If you have any comments or queries, please mail them to JainTcapApiFeedback@AePONA.Com

Copyright - 2000 Sun Microsystems