org.sakaiproject.entitybroker.entityprovider.capabilities
Interface ActionsExecutable

All Superinterfaces:

EntityProvider

All Known Subinterfaces:

ActionsDefineable, ActionsExecutionControllable, RESTful

public interface ActionsExecutable
extends EntityProvider

This entity supports custom actions (as defined by RoR and REST microformat: http://microformats.org/wiki/rest/urls)
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 the EntityCustomAction suffix to define the custom actions
You can describe the actions using the Describeable key: .action. = description
If you want more control then you can use ActionsDefineable and ActionsExecutionControllable

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

See Also:

for more details about the custom action methods

Field Summary

static String

ACTION_METHOD_SUFFIX Use this suffix or the EntityCustomAction annotation to indicate custom actions for your entities

Method Summary

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Field Detail

ACTION_METHOD_SUFFIX

static final String ACTION_METHOD_SUFFIX

Use this suffix or the EntityCustomAction annotation to indicate custom actions for your entities

See Also:

Constant Field Values