com.ibm.retail.si.mgmt.notifications
Class RtlNotification

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.management.Notification
              |
              +--com.ibm.retail.si.mgmt.notifications.RtlNotification
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
RtlAlertNotification, RtlConsumerNotification, RtlCriticalNotification, RtlDebugNotification, RtlEmergencyNotification, RtlErrorNotification, RtlInformationNotification, RtlNoticeNotification, RtlTracePointNotification, RtlWarningNotification

public abstract class RtlNotification
extends javax.management.Notification

This class is intended to be the base class used for all notifcations issued by all RSS components. It should never be instanciated itself, but rather one of it's derived classes should always be used. Base Notification classes are defined by this architecture that have the following order of significance: RtlCriticalNotification RtlEmergencyNotification RtlAlertNotification RtlErrorNotification RtlWarningNotification RtlNoticeNotification RtlInformationNotification RtlDebugNotification RtlTracePointNotification RtlConsumerNotification

Version:
1.00, 10/01/2003
Author:
Paul A. Ruocchio, Kriselie D Rivera
See Also:
Notification, RtlCriticalNotification, RtlEmergencyNotification, RtlAlertNotification, RtlErrorNotification, RtlWarningNotification, RtlNoticeNotification, RtlInformationNotification, RtlDebugNotification, RtlTracePointNotification, RtlConsumerNotification, Serialized Form

Field Summary
 
Fields inherited from class javax.management.Notification
source
 
Constructor Summary
protected RtlNotification(java.lang.Object source, java.lang.String Type)
           
protected RtlNotification(java.lang.Object source, java.lang.String Type, java.lang.String Message)
           
protected RtlNotification(java.lang.Object source, java.lang.String Type, java.lang.String Message, java.lang.Object userData)
           
 
Method Summary
 com.ibm.retail.si.mgmt.MgmtDeviceInfo getOriginatingDevice()
          Get information about the device that generated the notification.
 long GetSystemSequenceNo()
          Get the System level assigned sequence number.
 long GetSystemTimeStamp()
          Get the System level assigned Timestamp.
protected  void setOriginatingDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo deviceInfo)
          Used by the Master Agent to set the originating This is assigned at the time this Notification is received by the Master Agent.
protected  void SetSystemSequenceNo(long SeqNo)
          Used by the Master Agent to set a system wide sequence number.
protected  void SetSystemTimeStamp(long Stamp)
          Used by the Master Agent to set a system wide timestamp.
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getSource, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RtlNotification

protected RtlNotification(java.lang.Object source,
                          java.lang.String Type)

RtlNotification

protected RtlNotification(java.lang.Object source,
                          java.lang.String Type,
                          java.lang.String Message)

RtlNotification

protected RtlNotification(java.lang.Object source,
                          java.lang.String Type,
                          java.lang.String Message,
                          java.lang.Object userData)
Method Detail

GetSystemSequenceNo

public long GetSystemSequenceNo()
Get the System level assigned sequence number. This number is assigned to this notification by the Master Agent upon receipt.

Returns:
long, the system wide sequence number.

SetSystemSequenceNo

protected void SetSystemSequenceNo(long SeqNo)
Used by the Master Agent to set a system wide sequence number. This number is assigned at the time this Notification is received by the Master Agent.

Parameters:
SeqNo - - The system wide sequence number.

GetSystemTimeStamp

public long GetSystemTimeStamp()
Get the System level assigned Timestamp. This timestamp is assigned to this notification by the Master Agent upon receipt. This timestamp is relative to the MasterAgent, and is meant to give system- wide context to all notificaitons.

Returns:
SystemtStamp, the system wide timestamp.

SetSystemTimeStamp

protected void SetSystemTimeStamp(long Stamp)
Used by the Master Agent to set a system wide timestamp. This is assigned at the time this Notification is received by the Master Agent.

Parameters:
Stamp - - The system wide timestamp.

getOriginatingDevice

public com.ibm.retail.si.mgmt.MgmtDeviceInfo getOriginatingDevice()
Get information about the device that generated the notification. This value will be assigned when the notification is received by the MasterAgent

Returns:
deviceInfo - Source device information

setOriginatingDevice

protected void setOriginatingDevice(com.ibm.retail.si.mgmt.MgmtDeviceInfo deviceInfo)
Used by the Master Agent to set the originating This is assigned at the time this Notification is received by the Master Agent.

Parameters:
deviceInfo - - Source device information


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004