org.sakaiproject.entitybroker.entityprovider.capabilities

Interface RESTful

All Superinterfaces:

ActionsExecutable, CollectionResolvable, Createable, CRUDable, Deleteable, Describeable, EntityProvider, Formats, Inputable, Outputable, Redirectable, Resolvable, Sampleable, Saveable, Updateable

public interface RESTful
extends EntityProvider, CRUDable, CollectionResolvable, Outputable, Inputable, Describeable, ActionsExecutable, Redirectable

Indicates 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

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Field Summary

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

SEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

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

ACTION_METHOD_SUFFIX

Method Summary

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Createable

createEntity

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

getSampleEntity

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

updateEntity

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable

getEntity

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

getEntityPrefix

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable

deleteEntity

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

getEntities

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

getHandledOutputFormats

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable

getHandledInputFormats