org.codehaus.plexus.action
Interface Action

All Known Implementing Classes:
AbstractAction

public interface Action

An Action An action is an executable atomic computation. Actions may include operation calls, the creation or destruction of another object, or the sending of a signal to an object.

An action is atomic, meaning that it cannot be interrupted by an event and therefore runs to completion. This is in contrast to an activity, which may be interrupted by other events. 89

Version:
$Id: Action.java 2225 2005-07-10 22:33:38Z jvanzyl $
Author:
Jason van Zyl

Field Summary
static java.lang.String RESULT_MESSAGES
          Key for a result messages that must make its way to a user.
static java.lang.String ROLE
           
 
Method Summary
 void addResultMessage(java.lang.String message, java.util.Map parameters)
           
 void execute(java.util.Map context)
           
 java.util.List getResultMessages(java.util.Map parameters)
           
 boolean hasResultMessages(java.util.Map parameters)
           
 void setResultMessages(java.util.List resultMessages, java.util.Map parameters)
           
 

Field Detail

RESULT_MESSAGES

public static final java.lang.String RESULT_MESSAGES
Key for a result messages that must make its way to a user. This could be a validation result message that indicates something went wrong with processing inside an action.

See Also:
Constant Field Values

ROLE

public static final java.lang.String ROLE
Method Detail

setResultMessages

public void setResultMessages(java.util.List resultMessages,
                              java.util.Map parameters)

addResultMessage

public void addResultMessage(java.lang.String message,
                             java.util.Map parameters)

getResultMessages

public java.util.List getResultMessages(java.util.Map parameters)

hasResultMessages

public boolean hasResultMessages(java.util.Map parameters)

execute

public void execute(java.util.Map context)
             throws java.lang.Exception
Throws:
java.lang.Exception


Copyright © 2001-2007 Codehaus. All Rights Reserved.