edu.cmu.hcii.calo.messagePassing.HistoryMessage Class Reference

Inherits edu.cmu.hcii.calo.messagePassing.Message.

Inheritance diagram for edu.cmu.hcii.calo.messagePassing.HistoryMessage:

Inheritance graph
[legend]
Collaboration diagram for edu.cmu.hcii.calo.messagePassing.HistoryMessage:

Collaboration graph
[legend]
List of all members.

Detailed Description

A type of Message that pertains to the modification and management of History instances.

Author:
Will Haines


Public Types

enum  HistoryMessageType
 The possible types of a HistoryMessage. More...

Public Member Functions

 HistoryMessage (HistoryManager manager, HistoryMessageType type, HistoryItem h)
 Constructs a History Message for the given manager, message type, and history item.
 HistoryMessage (HistoryManager manager, HistoryMessageType type, HistoryItem h, Map< String, Object > userInfo)
 Constructs a HistoryMessage for the given manager, message type, history item, and user info map.
HistoryItem getHistoryItem ()
 Accessor method for a history item.

Private Member Functions

 HistoryMessage (Observable sender, MessageType type)
 Private constructor.
 HistoryMessage (Observable sender, MessageType type, Map< String, Object > userInfo)
 Private constructor.

Private Attributes

HistoryItem historyItem
 The History to which this message pertains.

Static Private Attributes

static final long serialVersionUID = -746178295541244767L
 To prevent serialization collisions.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::HistoryMessage::HistoryMessageType

The possible types of a HistoryMessage.

Author:
Will Haines


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.HistoryMessage.HistoryMessage ( HistoryManager  manager,
HistoryMessageType  type,
HistoryItem  h 
)

Constructs a History Message for the given manager, message type, and history item.

Parameters:
manager the manager sending the message
type the type of the message
h the History to which the message pertains

edu.cmu.hcii.calo.messagePassing.HistoryMessage.HistoryMessage ( HistoryManager  manager,
HistoryMessageType  type,
HistoryItem  h,
Map< String, Object >  userInfo 
)

Constructs a HistoryMessage for the given manager, message type, history item, and user info map.

Parameters:
manager the manager sending the message
type the type of the message
h the History to which the message pertains
userInfo the user info map for this message

edu.cmu.hcii.calo.messagePassing.HistoryMessage.HistoryMessage ( Observable  sender,
MessageType  type 
) [private]

Private constructor.

Use HistoryMessage.HistoryMessage(Observable, MessageType, History) instead.

Parameters:
sender the object that sent this message
type the type of this message

edu.cmu.hcii.calo.messagePassing.HistoryMessage.HistoryMessage ( Observable  sender,
MessageType  type,
Map< String, Object >  userInfo 
) [private]

Private constructor.

Use HistoryMessage.HistoryMessage(Observable, MessageType, History, Map) instead.

Parameters:
sender the object that sent this message
type the type of this message
userInfo the map of message-specific data associated with this message


Member Function Documentation

HistoryItem edu.cmu.hcii.calo.messagePassing.HistoryMessage.getHistoryItem (  ) 

Accessor method for a history item.

Returns:
the value of the history item


Member Data Documentation

final long edu.cmu.hcii.calo.messagePassing.HistoryMessage.serialVersionUID = -746178295541244767L [static, private]

To prevent serialization collisions.

HistoryItem edu.cmu.hcii.calo.messagePassing.HistoryMessage.historyItem [private]

The History to which this message pertains.


The documentation for this class was generated from the following file:
Generated on Mon Aug 13 15:06:15 2007 for CALO by  doxygen 1.5.2