|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use Formats | |
|---|---|
| org.sakaiproject.entitybroker.access | |
| org.sakaiproject.entitybroker.entityprovider.capabilities | |
| Uses of Formats in org.sakaiproject.entitybroker.access |
|---|
| Subinterfaces of Formats in org.sakaiproject.entitybroker.access | |
|---|---|
interface |
AccessFormats
Indicates that entity requests can be handled for certain formats which are indicated NOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider if nothing is specified here
or this interface is not implemented |
| Uses of Formats in org.sakaiproject.entitybroker.entityprovider.capabilities |
|---|
| Subinterfaces of Formats in org.sakaiproject.entitybroker.entityprovider.capabilities | |
|---|---|
interface |
Inputable
These entities can be entered as certain input formats which are handled automatically and translated into entity objects (of the type defined by Sampleable)If you want to define the way the input is translated instead of using the internal methods then use InputTranslatableNOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider |
interface |
InputTranslatable
Allows this entity to define the way to translate data for a reference into an entity object depending on the format requested, if you just want to use the internal methods to handle formatting the input into an entity then simply use InputableNOTE: throwing FormatUnsupportedException will pass control over to the internal
handlers for formatting, if you want to stop the request for this format type entirely then
throw an IllegalStateException and the processing will be halted |
interface |
Outputable
These entities can be returned as certain output formats which are handled automatically If you want to define the data that is returned instead of using the internal methods then use OutputFormattableNOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider
NOTE: there is no internal handling of HTML, it will always redirect to the the available access provider
if there is one (if there is not one then the entity will be toStringed) |
interface |
OutputFormattable
Allows this entity to define the output data format for a reference or a list of entity objects depending on the format requested, if you just want to use the internal methods to handle formatting the output then simply use OutputableNOTE: throwing FormatUnsupportedException will pass control over to the internal
handlers for formatting, if you want to stop the request for this format type entirely then
throw an IllegalStateException and the processing will be halted |
interface |
OutputSerializable
Allows this entity to better control the data that is going to be output by allowing it to intercept the entities and return them as whatever objects which should be serialized for output, if you just want to use the internal methods to handle formatting the output then simply use Outputable |
interface |
RESTful
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 |
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||