edu.cmu.hcii.calo.model.Notification Class Reference

Inherits edu.cmu.hcii.calo.model.PrioritizedObject.

Inheritance diagram for edu.cmu.hcii.calo.model.Notification:

Inheritance graph
[legend]
Collaboration diagram for edu.cmu.hcii.calo.model.Notification:

Collaboration graph
[legend]
List of all members.

Detailed Description

Represents a notification as generated by the CALO engine and visualized in the notification center.

Author:
Will Haines


Public Types

enum  NotificationType
 Possible notification types. More...

Public Member Functions

 Notification (NotificationType type, String name, String text, Person person)
 Construct a notification.
 Notification (NotificationType type, String name, String text)
 Construct a notification with an unknown person.
String getName ()
 Accessor method for notification name.
void setName (String name)
 Getter method for notification name.
double getPriority ()
 Accessor method for priority.
String getText ()
 Accessor method for notification text.
NotificationType getType ()
 Accessor method for this notification's type.
void setPriority (double priority)
 Setter method for priority.
void setText (String text)
 Setter method for associated text.
String toString ()
 Returns a string representation of this notification.
Person getPerson ()
 A getter for the person associated with this notification.
void setPerson (Person person)
 A setter for the person associated with this notification.

Private Attributes

NotificationType type
 The notification's type for purposes of coalescing.
String name
 This notification's name.
String text
 The text associated with the notification.
Person person
 The person associated with this notification if it is an email.
double priority
 The notification's priority.

Static Private Attributes

static final long serialVersionUID = -7704300813511007785L
 To prevent serialization collisons.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::model::Notification::NotificationType

Possible notification types.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.model.Notification.Notification ( NotificationType  type,
String  name,
String  text,
Person  person 
)

Construct a notification.

Parameters:
type this notification's type for coalescing
name this notification's name
text the text to display for this notification
person the person associated with this notification

edu.cmu.hcii.calo.model.Notification.Notification ( NotificationType  type,
String  name,
String  text 
)

Construct a notification with an unknown person.

Parameters:
type this notification's type for coalescing
name this notification's name
text the text to display for this notification


Member Function Documentation

String edu.cmu.hcii.calo.model.Notification.getName (  ) 

Accessor method for notification name.

Returns:
this notification's name

void edu.cmu.hcii.calo.model.Notification.setName ( String  name  ) 

Getter method for notification name.

Parameters:
name this notification's new name

double edu.cmu.hcii.calo.model.Notification.getPriority (  )  [virtual]

Accessor method for priority.

Returns:
the value of priority

Implements edu.cmu.hcii.calo.model.PrioritizedObject.

String edu.cmu.hcii.calo.model.Notification.getText (  ) 

Accessor method for notification text.

Returns:
this notification's associated text

NotificationType edu.cmu.hcii.calo.model.Notification.getType (  ) 

Accessor method for this notification's type.

Returns:
the value of this notification's type

void edu.cmu.hcii.calo.model.Notification.setPriority ( double  priority  ) 

Setter method for priority.

Parameters:
priority the priority to set

void edu.cmu.hcii.calo.model.Notification.setText ( String  text  ) 

Setter method for associated text.

Parameters:
text the text to set

String edu.cmu.hcii.calo.model.Notification.toString (  ) 

Returns a string representation of this notification.

Useful only for debugging.

Person edu.cmu.hcii.calo.model.Notification.getPerson (  ) 

A getter for the person associated with this notification.

Returns:
the person

void edu.cmu.hcii.calo.model.Notification.setPerson ( Person  person  ) 

A setter for the person associated with this notification.

Parameters:
person the person to set


Member Data Documentation

final long edu.cmu.hcii.calo.model.Notification.serialVersionUID = -7704300813511007785L [static, private]

To prevent serialization collisons.

NotificationType edu.cmu.hcii.calo.model.Notification.type [private]

The notification's type for purposes of coalescing.

String edu.cmu.hcii.calo.model.Notification.name [private]

This notification's name.

String edu.cmu.hcii.calo.model.Notification.text [private]

The text associated with the notification.

Person edu.cmu.hcii.calo.model.Notification.person [private]

The person associated with this notification if it is an email.

double edu.cmu.hcii.calo.model.Notification.priority [private]

The notification's priority.


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