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

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

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Author:
Brian Ellis


Public Types

enum  PrioritizableMessageType
 The possible types of a PrioritizableMessage. More...

Public Member Functions

 PrioritizableMessage (TaskManager manager, PrioritizableMessageType type, Prioritizable t)
 Constructs a PrioritizableMessage for the given manager, message type, and prioritizable.
 PrioritizableMessage (TaskManager manager, PrioritizableMessageType type, Prioritizable t, Map< String, Object > userInfo)
 Constructs a PrioritizableMessage for the given manager, message type, prioritizable, and user info map.
Prioritizable getPrioritizable ()
 Accessor method for prioritizable.
Observable getSender ()
 Accessor method for sender.
Map< String, Object > getUserInfo ()
 Accessor method for userInfo.
MessageType getMessageType ()
 Accessor method for messageType.

Protected Attributes

MessageType messageType
 The type of this message.

Private Member Functions

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

Private Attributes

Prioritizable prioritizable
 The Prioritizable to which this message pertains.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::PrioritizableMessage::PrioritizableMessageType

The possible types of a PrioritizableMessage.

Author:
Brian Ellis
Enumerator:
PRIORITIZABLE_ADDED  The prioritizable has just been added to the manager.

PRIORITIZABLE_REMOVED  The prioritizable has just been removed from the manager.


Constructor & Destructor Documentation

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

Private constructor.

Use PrioritizableMessage.PrioritizableMessage(Observable, MessageType, Prioritizable, 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

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

Private constructor.

Use PrioritizableMessage.PrioritizableMessage(Observable, MessageType, Prioritizable) instead.

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

edu.cmu.hcii.calo.messagePassing.PrioritizableMessage.PrioritizableMessage ( TaskManager  manager,
PrioritizableMessageType  type,
Prioritizable  t 
)

Constructs a PrioritizableMessage for the given manager, message type, and prioritizable.

Parameters:
manager the manager sending the message
type the type of the message
t the Prioritizable to which the message pertains

edu.cmu.hcii.calo.messagePassing.PrioritizableMessage.PrioritizableMessage ( TaskManager  manager,
PrioritizableMessageType  type,
Prioritizable  t,
Map< String, Object >  userInfo 
)

Constructs a PrioritizableMessage for the given manager, message type, prioritizable, and user info map.

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


Member Function Documentation

Prioritizable edu.cmu.hcii.calo.messagePassing.PrioritizableMessage.getPrioritizable (  ) 

Accessor method for prioritizable.

Returns:
the value of prioritizable

Observable edu.cmu.hcii.calo.messagePassing.Message.getSender (  )  [inherited]

Accessor method for sender.

Returns:
the value of sender

Map<String, Object> edu.cmu.hcii.calo.messagePassing.Message.getUserInfo (  )  [inherited]

Accessor method for userInfo.

Returns:
the value of userInfo

MessageType edu.cmu.hcii.calo.messagePassing.Message.getMessageType (  )  [inherited]

Accessor method for messageType.

Returns:
the value of messageType


Member Data Documentation

Prioritizable edu.cmu.hcii.calo.messagePassing.PrioritizableMessage.prioritizable [private]

The Prioritizable to which this message pertains.

MessageType edu.cmu.hcii.calo.messagePassing.Message.messageType [protected, inherited]

The type of this message.


The documentation for this class was generated from the following file:
Generated on Tue Jun 26 22:17:01 2007 for CALO by  doxygen 1.5.2