| java.lang.Object org.sakaiproject.content.util.BaseResourceAction org.sakaiproject.content.util.BaseInteractionAction
All known Subclasses: org.sakaiproject.metaobj.registry.CreateFormInteractionAction,
BaseInteractionAction | public class BaseInteractionAction extends BaseResourceAction implements InteractionAction(Code) | | Created by IntelliJ IDEA.
User: johnellis
Date: Jan 26, 2007
Time: 10:33:57 AM
To change this template use File | Settings | File Templates.
|
Method Summary | |
public void | cancelAction(Reference reference, String initializationId) ResourcesAction calls this method if the user cancels out of the action or some error
occurs preventing completion of the action after the helper completes its part of the
action. | public void | finalizeAction(Reference reference, String initializationId) ResourcesAction calls this method after completion of its portion of the action. | public String | getHelperId() Access the unique identifier for the tool that will handle this action. | public List | getRequiredPropertyKeys() Access a list of properties that should be provided to the helper if they are defined. | public String | initializeAction(Reference reference) ResourcesAction calls this method before starting the helper. |
BaseInteractionAction | public BaseInteractionAction(String id, ActionType actionType, String typeId, String helperId, List requiredPropertyKeys)(Code) | | |
cancelAction | public void cancelAction(Reference reference, String initializationId)(Code) | | ResourcesAction calls this method if the user cancels out of the action or some error
occurs preventing completion of the action after the helper completes its part of the
action.
Parameters: reference - Parameters: initializationId - |
finalizeAction | public void finalizeAction(Reference reference, String initializationId)(Code) | | ResourcesAction calls this method after completion of its portion of the action.
Parameters: reference - The Parameters: initializationId - |
getHelperId | public String getHelperId()(Code) | | Access the unique identifier for the tool that will handle this action.
This is the identifier by which the helper is registered with the
ToolManager.
|
getRequiredPropertyKeys | public List getRequiredPropertyKeys()(Code) | | Access a list of properties that should be provided to the helper if they are defined.
Returning null or empty list indicates no properties are needed by the helper.
a List of Strings if property values are required. |
initializeAction | public String initializeAction(Reference reference)(Code) | | ResourcesAction calls this method before starting the helper. This is intended to give
the registrant a chance to do any preparation needed before the helper starts with respect
to this action and the reference specified in the parameter. The method returns a String
(possibly null) which will be provided as the "initializationId" parameter to other
methods and in
Parameters: reference - |
|
|