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

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

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

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

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


User info map keys

These strings are the defined keys for use in the user info dictionary.

static final String OLD_SUBTASKS = "OldSubtasks"
 The old subtasks.
static final String NEW_SUBTASKS = "NewSubtasks"
 The new subtasks.
static final long serialVersionUID = -7455516326133953320L
 To prevent serialization collisions.

User info map keys

These strings are the defined keys for use in the user info dictionary.

TaskGroup getTaskGroup ()
 Accessor method for taskGroup.
 TaskGroupMessage (Observable sender, MessageType type)
 Private constructor.
 TaskGroupMessage (Observable sender, MessageType type, Map< String, Object > userInfo)
 Private constructor.

Public Types

enum  TaskGroupMessageType
 The possible types of a PrioritizedObjectMessage. More...

Public Member Functions

 TaskGroupMessage (AbstractManager manager, TaskGroupMessageType type, TaskGroup t)
 Constructs a TaskGroupMessage for the given manager, message type, and taskGroup.
 TaskGroupMessage (AbstractManager manager, TaskGroupMessageType type, TaskGroup t, Map< String, Object > userInfo)
 Constructs a PrioritizedObjectMessage for the given manager, message type, taskGroup, and user info map.

Private Attributes

TaskGroup taskGroup
 The Prioritizable to which this message pertains.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::TaskGroupMessage::TaskGroupMessageType

The possible types of a PrioritizedObjectMessage.

Author:
Brian Ellis


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.TaskGroupMessage.TaskGroupMessage ( AbstractManager  manager,
TaskGroupMessageType  type,
TaskGroup  t 
)

Constructs a TaskGroupMessage for the given manager, message type, and taskGroup.

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

edu.cmu.hcii.calo.messagePassing.TaskGroupMessage.TaskGroupMessage ( AbstractManager  manager,
TaskGroupMessageType  type,
TaskGroup  t,
Map< String, Object >  userInfo 
)

Constructs a PrioritizedObjectMessage for the given manager, message type, taskGroup, 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

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

Private constructor.

Use TaskGroupMessage.TaskGroupMessage(Observable, MessageType, TaskGroup) instead.

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

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

Private constructor.

Use TaskGroupMessage.TaskGroupMessage(Observable, MessageType, TaskGroup, 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

TaskGroup edu.cmu.hcii.calo.messagePassing.TaskGroupMessage.getTaskGroup (  ) 

Accessor method for taskGroup.

Returns:
the value of taskGroup


Member Data Documentation

final String edu.cmu.hcii.calo.messagePassing.TaskGroupMessage.OLD_SUBTASKS = "OldSubtasks" [static]

The old subtasks.

final String edu.cmu.hcii.calo.messagePassing.TaskGroupMessage.NEW_SUBTASKS = "NewSubtasks" [static]

The new subtasks.

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

To prevent serialization collisions.

TaskGroup edu.cmu.hcii.calo.messagePassing.TaskGroupMessage.taskGroup [private]

The Prioritizable 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