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

List of all members.

Detailed Description

Represents the state of a task as pending or non-pending.

Author:
Brian Ellis


Public Member Functions

 PendingState ()
 Creates a default pending state; this means that isPending is false and pendingNote is null;.
 PendingState (boolean isPending)
 Creates a pending state with the given pending status.
boolean equals (Object obj)
 Indicates whether some other object is "equal to" this one.
String getPendingNote ()
 Accessor method for pendingNote.
String getPerson ()
 Accessor method for person.
int hashCode ()
 Returns a hash code value for the object.
boolean isPending ()
 Accessor method for whether or not the associated task is pending.
void setPending (boolean isPending)
 Setter method whether or not the associated task is pending.
void setPendingNote (String pendingNote)
 Setter method for pendingNote.
String toString ()
 Returns a string representation of this PendingState.
void setPerson (String person)
 Sets the name of the person associated with this pending state.

Private Attributes

boolean isPending
 Whether this task is currently pending on something.
String pendingNote
 The textual note the user entered as the reason this task is pending, if any such note exists.
String person
 The name of the person the user entered as the reason this task is pending, if any such name exists.

Static Private Attributes

static final long serialVersionUID = -8421898332536226325L
 Prevent serialization collisions.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.model.PendingState.PendingState (  ) 

Creates a default pending state; this means that isPending is false and pendingNote is null;.

edu.cmu.hcii.calo.model.PendingState.PendingState ( boolean  isPending  ) 

Creates a pending state with the given pending status.

Parameters:
isPending the pending status to set


Member Function Documentation

boolean edu.cmu.hcii.calo.model.PendingState.equals ( Object  obj  ) 

Indicates whether some other object is "equal to" this one.

Parameters:
obj the object this one may or may not be equal to
See also:
java.lang.Object.equals(java.lang.Object)

String edu.cmu.hcii.calo.model.PendingState.getPendingNote (  ) 

Accessor method for pendingNote.

Returns:
the value of pendingNote

String edu.cmu.hcii.calo.model.PendingState.getPerson (  ) 

Accessor method for person.

Returns:
the value of person

int edu.cmu.hcii.calo.model.PendingState.hashCode (  ) 

Returns a hash code value for the object.

This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

See also:
java.lang.Object.hashCode()

boolean edu.cmu.hcii.calo.model.PendingState.isPending (  ) 

Accessor method for whether or not the associated task is pending.

Returns:
true if the associated task is pending

void edu.cmu.hcii.calo.model.PendingState.setPending ( boolean  isPending  ) 

Setter method whether or not the associated task is pending.

Parameters:
isPending the pending value to set

void edu.cmu.hcii.calo.model.PendingState.setPendingNote ( String  pendingNote  ) 

Setter method for pendingNote.

Parameters:
pendingNote the pendingNote to set

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

Returns a string representation of this PendingState.

Useful only for debugging.

void edu.cmu.hcii.calo.model.PendingState.setPerson ( String  person  ) 

Sets the name of the person associated with this pending state.

Parameters:
person the name of the person


Member Data Documentation

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

Prevent serialization collisions.

boolean edu.cmu.hcii.calo.model.PendingState.isPending [private]

Whether this task is currently pending on something.

String edu.cmu.hcii.calo.model.PendingState.pendingNote [private]

The textual note the user entered as the reason this task is pending, if any such note exists.

(If not, this will be the empty string.)

String edu.cmu.hcii.calo.model.PendingState.person [private]

The name of the person the user entered as the reason this task is pending, if any such name exists.

(If not, this will be the empty string.)


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