ix.ip2
Class HandlerAction

java.lang.Object
  |
  +--ix.ip2.HandlerAction
Direct Known Subclasses:
ActivityAgenda.ExpandAction, ForwardingHandler.ForwardingAction, HandlerAction.Automatic, HandlerAction.Manual, HandlerAction.NoAction, InvokeHandler.InvokeAction, QueryHandler.QueryAction

public class HandlerAction
extends java.lang.Object

One of the ways in which an agenda item might be handled.


Inner Class Summary
static class HandlerAction.Automatic
          Handles an issue by invoking one of the agent-level issue-handlers.
(package private) static class HandlerAction.Manual
          Indicates that the item has been handled by the user.
(package private) static class HandlerAction.NoAction
          Handles an item by doing nothing.
(package private) static class HandlerAction.NotApplicable
          Used to indicate the the item does not apply in the current situation.
 
Field Summary
protected  java.lang.String shortDescription
          Briefly describes what this action does.
 
Constructor Summary
(package private) HandlerAction()
          Constructor used by subclasses.
 
Method Summary
 void computeStatus()
          Called when something has happened that might have changed this action's ready status.
 java.lang.String getActionDescription()
          Returns a brief description of how this action would handle an item.
 void handle(AgendaItem item)
          Handle the item in the manner appropriate to this handler-action.
 boolean isReady()
          Indicates whether this action is ready to be used or else is waiting for something that would enable it to be used.
 boolean isStillValid()
          Called when something has happened that might mean this action no longer makes sense and should be deleted.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

shortDescription

protected java.lang.String shortDescription
Briefly describes what this action does.
Constructor Detail

HandlerAction

HandlerAction()
Constructor used by subclasses.
Method Detail

handle

public void handle(AgendaItem item)
Handle the item in the manner appropriate to this handler-action. This method merely changes the item's status to COMPLETE and is overridden in subclasses that handle the item in more interesting ways.

isStillValid

public boolean isStillValid()
Called when something has happened that might mean this action no longer makes sense and should be deleted. This method just returns true and is overridden in subclasses that have instances that may cease to be valid.

isReady

public boolean isReady()
Indicates whether this action is ready to be used or else is waiting for something that would enable it to be used. This method just returns true and is overridden in subclasses that have instances that are not always ready.

computeStatus

public void computeStatus()
Called when something has happened that might have changed this action's ready status. This method does nothing and is overridden in subclasses that have instances that are not always ready.

getActionDescription

public java.lang.String getActionDescription()
Returns a brief description of how this action would handle an item.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object