Uses of Interface
org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
-
Packages that use ActionsExecutable Package Description org.sakaiproject.entitybroker.entityprovider.capabilities org.sakaiproject.entitybroker.providers -
-
Uses of ActionsExecutable in org.sakaiproject.entitybroker.entityprovider.capabilities
Subinterfaces of ActionsExecutable in org.sakaiproject.entitybroker.entityprovider.capabilities Modifier and Type Interface Description interfaceActionsDefineableThis 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 useActionsExecutionControllableinterfaceActionsExecutionControllableThis entity supports custom actions (as defined by RoR and REST microformat: http://microformats.org/wiki/rest/urls)
This is the most complex interface for implementing custom actions but allows the most control also, useActionsExecutableorActionsDefineablein most circumstance
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 describe the actions using theDescribeablekey:.action. = description
You can create methods in your entity provider which either end with "CustomAction" or use theEntityCustomActionsuffix to define the custom actionsinterfaceRESTfulIndicates that entities handled by this provider are RESTful as defined by the REST microformat:
http://microformats.org/wiki/rest/urls
Requires all CRUD functionality, Collection handling, HTML handling, and ability to support output formats
This is mostly a convenience interface to make sure that everything needed to support REST has been implemented, it also includes the marker to indicate that RESTful URLs should work for entities of this type -
Uses of ActionsExecutable in org.sakaiproject.entitybroker.providers
Methods in org.sakaiproject.entitybroker.providers with parameters of type ActionsExecutable Modifier and Type Method Description ActionReturnEntityRESTProvider. handleCustomActionExecution(ActionsExecutable actionProvider, EntityReference ref, String action, Map<String,Object> actionParams, OutputStream outputStream, EntityView view, Map<String,Object> searchParams)This will execute a custom action for an entity or space/collection of entities
This is meant for specialized usage as custom actions are typically meant to be executed by REST calls only
-