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

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

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Author:
Brian Ellis


Public Types

enum  ScheduleMessageType
 The possible types of a ScheduleMessage. More...

Public Member Functions

 ScheduleMessage (ScheduleManager manager, ScheduleMessageType type, ScheduleItem item)
 Constructs a TaskMessage for the given manager, message type, and scheduleItem.
 ScheduleMessage (ScheduleManager manager, ScheduleMessageType type, ScheduleItem item, Map< String, Object > userInfo)
 Constructs a TaskMessage for the given manager, message type, scheduleItem, and user info map.
ScheduleItem getScheduleItem ()
 Accessor method for scheduleItem.

Static Public Attributes

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

static final String OLD_START_TIME = "OldStartTime"
 The old due date.
static final String NEW_START_TIME = "NewStartTime"
 The new due date.
static final String OLD_NAME = "OldName"
 The old name.
static final String NEW_NAME = "NewName"
 The new name.
static final String OLD_END_TIME = "OldEndTime"
 The old priority.
static final String NEW_END_TIME = "NewEndTime"
 The new priority.
static final String OLD_HAS_REMINDER = "OldHasReminder"
 The old pending state.
static final String NEW_HAS_REMINDER = "NewHasReminder"
 The new pending state.
static final String OLD_RESOURCES = "OldResources"
 The old resources.
static final String NEW_RESOURCES = "NewResources"
 The new resources.
static final String OLD_TAGS = "OldTags"
 The old tags.
static final String NEW_TAGS = "NewTags"
 The new tags.
static final String OLD_PROJECT = "OldProject"
 The old project.
static final String NEW_PROJECT = "NewProject"
 The new project.

Private Member Functions

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

Private Attributes

ScheduleItem scheduleItem
 The ScheduleItem to which this message pertains.

Static Private Attributes

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


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::ScheduleMessage::ScheduleMessageType

The possible types of a ScheduleMessage.

Author:
Brian Ellis


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.ScheduleMessage.ScheduleMessage ( ScheduleManager  manager,
ScheduleMessageType  type,
ScheduleItem  item 
)

Constructs a TaskMessage for the given manager, message type, and scheduleItem.

Parameters:
manager the manager sending the message
type the type of the message
item the scheduleItem to which the message pertains

edu.cmu.hcii.calo.messagePassing.ScheduleMessage.ScheduleMessage ( ScheduleManager  manager,
ScheduleMessageType  type,
ScheduleItem  item,
Map< String, Object >  userInfo 
)

Constructs a TaskMessage for the given manager, message type, scheduleItem, and user info map.

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

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

Private constructor.

Use ScheduleMessage.ScheduleMessage(Observable, MessageType, ScheduleItem) instead.

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

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

Private constructor.

Use ScheduleMessage.ScheduleMessage(Observable, MessageType, ScheduleItem, 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

ScheduleItem edu.cmu.hcii.calo.messagePassing.ScheduleMessage.getScheduleItem (  ) 

Accessor method for scheduleItem.

Returns:
the value of scheduleItem


Member Data Documentation

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_START_TIME = "OldStartTime" [static]

The old due date.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_START_TIME = "NewStartTime" [static]

The new due date.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_NAME = "OldName" [static]

The old name.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_NAME = "NewName" [static]

The new name.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_END_TIME = "OldEndTime" [static]

The old priority.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_END_TIME = "NewEndTime" [static]

The new priority.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_HAS_REMINDER = "OldHasReminder" [static]

The old pending state.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_HAS_REMINDER = "NewHasReminder" [static]

The new pending state.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_RESOURCES = "OldResources" [static]

The old resources.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_RESOURCES = "NewResources" [static]

The new resources.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_TAGS = "OldTags" [static]

The old tags.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_TAGS = "NewTags" [static]

The new tags.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.OLD_PROJECT = "OldProject" [static]

The old project.

final String edu.cmu.hcii.calo.messagePassing.ScheduleMessage.NEW_PROJECT = "NewProject" [static]

The new project.

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

To prevent serialization collisions.

ScheduleItem edu.cmu.hcii.calo.messagePassing.ScheduleMessage.scheduleItem [private]

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