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

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

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

A type of Message that pertains to the modification and management of relevant actions in the RelevantInfoManager.

Author:
Brian Ellis


Public Types

enum  RelevantActionMessageType
 The possible types of a RelevantActionMessage. More...

Public Member Functions

 RelevantActionMessage (RelevantInfoManager manager, RelevantActionMessageType type, List< RelevantAction > actions)
 Constructs a RelevantActionMessage for the given manager, message type, and action list.
 RelevantActionMessage (RelevantInfoManager manager, RelevantActionMessageType type, List< RelevantAction > actions, Map< String, Object > userInfo)
 Constructs a RelevantActionMessage for the given manager, message type, resource list, and user info map.
List< RelevantActiongetActions ()
 Accessor method for actions.

Private Member Functions

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

Private Attributes

List< RelevantActionactions
 The actions to which this message pertains.

Static Private Attributes

static final long serialVersionUID = 4916357308108903899L
 To prevent serialization collisions.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::RelevantActionMessage::RelevantActionMessageType

The possible types of a RelevantActionMessage.

Currently there is only one of these, because the relevant action list will typically change wholesale rather than selective elements being added or deleted.

Author:
Brian Ellis


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.RelevantActionMessage.RelevantActionMessage ( RelevantInfoManager  manager,
RelevantActionMessageType  type,
List< RelevantAction actions 
)

Constructs a RelevantActionMessage for the given manager, message type, and action list.

Parameters:
manager the manager sending the message
type the type of the message
actions the action list to which the message pertains

edu.cmu.hcii.calo.messagePassing.RelevantActionMessage.RelevantActionMessage ( RelevantInfoManager  manager,
RelevantActionMessageType  type,
List< RelevantAction actions,
Map< String, Object >  userInfo 
)

Constructs a RelevantActionMessage for the given manager, message type, resource list, and user info map.

Parameters:
manager the manager sending the message
type the type of the message
actions the action list to which the message pertains
userInfo the user info map for this message

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

Private constructor.

Use RelevantActionMessage.RelevantActionMessage(Observable, MessageType, List) instead.

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

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

Private constructor.

Use RelevantActionMessage.RelevantActionMessage(Observable, MessageType, List, 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

List<RelevantAction> edu.cmu.hcii.calo.messagePassing.RelevantActionMessage.getActions (  ) 

Accessor method for actions.

Returns:
the value of actions


Member Data Documentation

final long edu.cmu.hcii.calo.messagePassing.RelevantActionMessage.serialVersionUID = 4916357308108903899L [static, private]

To prevent serialization collisions.

List<RelevantAction> edu.cmu.hcii.calo.messagePassing.RelevantActionMessage.actions [private]

The actions to which this message pertains.


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