org.argouml.cognitive
Interface Poster

All Known Implementing Classes:
Designer

public interface Poster

Interface that defines methods required on any object that can post a ToDoItem to the Designer's ToDoList. Basically requires that the poster (1) have contact information, (2) be able to snooze and unsnooze itself, and (3) be able to determine if a ToDoItem it posted previously should still be on the Designer's ToDoList.

Currently Critic and Designer implement this interface.

See Also:
Critic, Designer

Method Summary
 boolean canFixIt(ToDoItem item)
           
 boolean containsKnowledgeType(String knowledgeType)
           
 String expand(String desc, ListSet offs)
          Customize the description string just before it is displayed.
 void fixIt(ToDoItem item, Object arg)
          TODO: Not implemented yet.
 Icon getClarifier()
           
 String getExpertEmail()
          Get some contact information on the Poster.
 Vector getSupportedDecisions()
           
 Vector getSupportedGoals()
           
 void setExpertEmail(String addr)
          Update the Poster's contact info.
 void snooze()
          Temporarily disable this Poster.
 boolean stillValid(ToDoItem i, Designer d)
          Reply true if the given item should be kept on the Designer's ToDoList, false if it is no longer valid.
 boolean supports(Decision d)
           
 boolean supports(Goal g)
           
 void unsnooze()
          Unsnooze this Poster, it may resume posting without further delay.
 

Method Detail

getExpertEmail

public String getExpertEmail()
Get some contact information on the Poster.

Returns:
the email address of the poster

setExpertEmail

public void setExpertEmail(String addr)
Update the Poster's contact info. Is this needed?

Parameters:
addr - the emailaddress

stillValid

public boolean stillValid(ToDoItem i,
                          Designer d)
Reply true if the given item should be kept on the Designer's ToDoList, false if it is no longer valid.

Parameters:
i - the todo item
d - the designer
Returns:
true if thisitem is still valid

supports

public boolean supports(Decision d)
Parameters:
d - the decision
Returns:
true if the decision is still supported

getSupportedDecisions

public Vector getSupportedDecisions()
Returns:
the list of supported decisions

supports

public boolean supports(Goal g)
Parameters:
g - the goal
Returns:
true if the goal is still supported

getSupportedGoals

public Vector getSupportedGoals()
Returns:
the list of supported goals

containsKnowledgeType

public boolean containsKnowledgeType(String knowledgeType)
Parameters:
knowledgeType - the knowledge type
Returns:
true if it is valid

expand

public String expand(String desc,
                     ListSet offs)
Customize the description string just before it is displayed.

Parameters:
desc - the description
offs - the offenders
Returns:
the customized/expanded string

getClarifier

public Icon getClarifier()
Returns:
the icon shown on the todo item to show the wizard's progress

snooze

public void snooze()
Temporarily disable this Poster.


unsnooze

public void unsnooze()
Unsnooze this Poster, it may resume posting without further delay.


fixIt

public void fixIt(ToDoItem item,
                  Object arg)
TODO: Not implemented yet. If the given ToDoItem can be fixed automatically, and the user wants that to happen, then do it. Obviously, this depends on the specific Critic and problem. By default this method does nothing.

Parameters:
item - the todo item
arg - the design material (?)

canFixIt

public boolean canFixIt(ToDoItem item)
Parameters:
item - the todo item
Returns:
true if it can be fixed


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Cookbook