org.sakaiproject.entitybroker.entityprovider
Interface EntityProvider

All Known Subinterfaces:

ActionsDefineable, ActionsExecutable, ActionsExecutionControllable, AutoRegisterEntityProvider, Browseable, BrowseableCollection, BrowseNestable, BrowseSearchable, CollectionResolvable, CoreEntityProvider, Createable, CRUDable, Deleteable, Describeable, DescribeDefineable, DescribePropertiesable, EntityViewUrlCustomizable, Exportable, Importable, Inputable, InputTranslatable, Outputable, OutputFormattable, OutputSerializable, Propertyable, PropertyProvideable, Redirectable, RedirectControllable, RedirectDefinable, ReferenceParseable, RequestAware, RequestHandler, RequestInterceptor, RequestStorable, Resolvable, RESTful, Sampleable, Saveable, Searchable, Statisticable, Taggable, TagProvideable, TagSearchable, Updateable

public interface EntityProvider

Beans may implement this interface directly to provide "extension" capabilities to an existing CoreEntityProvider. If you are the provider for a set of entities then you will want to implement CoreEntityProvider, this interface is primarily for extending an existing entity provider (adding extra functionality to one that is already registered Usage:
1) Implement this interface
2) Implement any additional capabilities interfaces (optional, but it would be crazy not to do at least one)
3) Create a spring bean definition in the Sakai application context (components.xml)
4) Implement AutoRegisterEntityProvider or register this implementation some other way

Author:

Aaron Zeckoski (aaronz@vt.edu), Antranig Basman (antranig@caret.cam.ac.uk)

Method Summary

String

getEntityPrefix() Controls the globally unique prefix for the entities handled by this provider For example: Announcements might use "annc", Evaluation might use "eval" (if this is not actually unique then an exception will be thrown when Sakai attempts to register this broker) (the global reference string will consist of the entity prefix and the local id)

Method Detail

getEntityPrefix

String getEntityPrefix()

Controls the globally unique prefix for the entities handled by this provider
For example: Announcements might use "annc", Evaluation might use "eval" (if this is not actually unique then an exception will be thrown when Sakai attempts to register this broker)
(the global reference string will consist of the entity prefix and the local id)

Returns:

the string that represents the globally unique prefix for an entity type