Interface Inputable
-
- All Superinterfaces:
EntityProvider,Formats,Sampleable
- All Known Subinterfaces:
InputTranslatable,RESTful
public interface Inputable extends EntityProvider, Formats, Sampleable
These entities can be entered as certain input formats which are handled automatically and translated into entity objects (of the type defined bySampleable)
If you want to define the way the input is translated instead of using the internal methods then useInputTranslatable
NOTE: By default all entity view requests go through to the available access providers:EntityViewAccessProviderorHttpServletAccessProvider- Author:
- Aaron Zeckoski (aaron@caret.cam.ac.uk)
-
-
Field Summary
-
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String[]getHandledInputFormats()Defines the input format types (extensions) handled by this provider
NOTE: In the case of an entity view the extension which goes on the end of an entity URL (after a ".") indicates the input type
WARNING: not includingFormats.HTMLin the return will stop all redirects to the access providers and therefore will cause HTML requests for entities to go nowhere-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider
getEntityPrefix
-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
getSampleEntity
-
-
-
-
Method Detail
-
getHandledInputFormats
String[] getHandledInputFormats()
Defines the input format types (extensions) handled by this provider
NOTE: In the case of an entity view the extension which goes on the end of an entity URL (after a ".") indicates the input type
WARNING: not includingFormats.HTMLin the return will stop all redirects to the access providers and therefore will cause HTML requests for entities to go nowhere- Returns:
- an array containing the extension formats (from
Formats) handled, use the constants (example:Formats.XML) or feel free to make up your own if you like
-
-