Interface ActionsDefineable
-
- All Superinterfaces:
ActionsExecutable,EntityProvider
- All Known Subinterfaces:
ActionsExecutionControllable
public interface ActionsDefineable extends ActionsExecutable
This entity supports custom actions (as defined by RoR and REST microformat: http://microformats.org/wiki/rest/urls)
This is the more controllable version, useActionsExecutableif you want to use the conventions and allow the system to detect your custom actions based on method names and annotations
This means that there are custom actions which can be invoked on entities or entity spaces, custom actions can augment the current entity operation or they can completely change the behavior and skip the current operation entirely
You can create methods in your entity provider which either end with "CustomAction" or use theEntityCustomActionsuffix to define the custom actions
You can describe the actions using theDescribeablekey:.action. = description
If you want more control then you can useActionsExecutionControllable- Author:
- Aaron Zeckoski (azeckoski @ gmail.com)
-
-
Field Summary
-
Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
ACTION_METHOD_SUFFIX
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CustomAction[]defineActions()Defines the custom actions which are allowed to be performed on your entities-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider
getEntityPrefix
-
-
-
-
Method Detail
-
defineActions
CustomAction[] defineActions()
Defines the custom actions which are allowed to be performed on your entities- Returns:
- an array of the custom actions in the order they should be checked
for in incoming requests
The action keys should match with public methods in your provider which end withActionsExecutable.ACTION_METHOD_SUFFIXor have theEntityCustomActionannotation on them, use the fields inCustomActionto define the methodName - See Also:
for details about what to return,for more info on what your methods should look like
-
-