| org.sakaiproject.content.api.InteractionAction
All known Subclasses: org.sakaiproject.content.util.BaseInteractionAction,
| InteractionAction | | public interface InteractionAction extends ResourceToolAction(Code) | | An InteractionAction defines a kind of ResourceToolAction which involves
user interaction to complete the action. The Resources tool will invoke
a helper to render an html page (or possibly a series of pages), process
the response(s) and turn control back to the Resources tool when done.
Before invoking the helper, ResourcesAction will call initializeAction()
supplying a Reference onject as a parameter. Implementations of this
interface may do whatever is necessary to prepare for invocation of the
helper and they may return an identifier for that initialization.
After starting the helper and getting back control from the helper,
ResourcesAction will call either finalizeAction or cancelAction to indicate
that the user either finalized the action or canceled it. The registrant may
do whatever is necessary to commit any changes in persistant storage (other
than changes to the referenced resource in ContentHosting) or reverse them.
|
| 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. |
| 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 - |
|
|