org.sakaiproject.entitybroker.entityprovider.capabilities

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, use ActionsExecutable if 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 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 ActionsExecutionControllable

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Field Summary

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

ACTION_METHOD_SUFFIX

Method Summary

Methods

Modifier and Type	Method and 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 with ActionsExecutable.ACTION_METHOD_SUFFIX or have the EntityCustomAction annotation on them, use the fields in CustomAction to define the methodName

See Also:

for details about what to return, for more info on what your methods should look like