Uses of Package
org.sakaiproject.entitybroker.entityprovider.extension
-
Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker Class Description ActionReturn A special object used to return specialized results from a custom action execution, includes fields to allow for handling of encoded binary data and to indicate that entity action processing should continue as it would have if there had been no custom action call (rather than exiting the standard chain)BrowseEntity This is an object to hold data about a browseable entity typeEntityData This is an object to hold entity data (e.g. from a search which would normally return entity references), This is basically a POJO which allows us to return a few results instead of only the reference, it helps us get the entity data back more efficiently and makes it easier on developers who need to search for entitiesLearningTrackingProvider This provides for tracking learning events (LRS statements) related to an entity (by prefix)
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.PropertiesProvider This simple defines the methods correctly which are shared between a set of interfaces, seePropertyProvideablefor more informationRequestGetterWrite Allows for getting to the request and response objects for the current threadRequestStorageWrite This allows write access to values which are stored in the current request thread, these values are inaccessible outside of a request and will be destroyed when the thread ends
This also "magically" exposes all the values in the request (attributes and params) as if they were stored in the map as well, if there are conflicts then locally stored data always wins over data from the request
Standard reserved keys have values that are always available:
_locale :Locale_requestEntityReference : String _requestActive : [true,false] _requestOrigin : ['REST','EXTERNAL','INTERNAL']SearchProvider Defines the methods related to searching for entities (shared between interfaces), implementing this allows for support for the core EB search functionalityTagProvider Defines the methods related to tagging entities (shared between interfaces) -
Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.access Class Description Formats Defines a list of possible format types (extensions) which can be handled and indicates which are handled internally -
Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.entityprovider Class Description CustomAction This defines a custom entity action, this will be used to define which custom actions are allowed to be performed on entities or collections of entitiesEntityProviderListener This allows a developer to be notified whenever a provider is registered, it will also ensure that it calls the listener method for any providers that are already registered when it is first registered if desired
Usage:
Just implement this class and useEntityProviderManager#registerNotifier(EntityProviderNotifier)to register it with the system.RequestGetterWrite Allows for getting to the request and response objects for the current threadRequestStorageWrite This allows write access to values which are stored in the current request thread, these values are inaccessible outside of a request and will be destroyed when the thread ends
This also "magically" exposes all the values in the request (attributes and params) as if they were stored in the map as well, if there are conflicts then locally stored data always wins over data from the request
Standard reserved keys have values that are always available:
_locale :Locale_requestEntityReference : String _requestActive : [true,false] _requestOrigin : ['REST','EXTERNAL','INTERNAL']URLRedirect Storage for the redirects -
Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.entityprovider.capabilities Class Description CustomAction This defines a custom entity action, this will be used to define which custom actions are allowed to be performed on entities or collections of entitiesEntityData This is an object to hold entity data (e.g. from a search which would normally return entity references), This is basically a POJO which allows us to return a few results instead of only the reference, it helps us get the entity data back more efficiently and makes it easier on developers who need to search for entitiesFormats Defines a list of possible format types (extensions) which can be handled and indicates which are handled internallyPropertiesProvider This simple defines the methods correctly which are shared between a set of interfaces, seePropertyProvideablefor more informationRequestGetter Allows for getting to the request and response objects for the current threadRequestStorage This allows access to values which are stored in the current request thread, these values are inaccessible outside of a request and will be destroyed when the thread ends
This also "magically" exposes all the values in the request (attributes and params) as if they were stored in the map as well, if there are conflicts then locally stored data always wins over data from the request
Standard reserved keys have values that are always available:
_locale :Locale_requestEntityReference : String _requestActive : [true,false] _requestOrigin : ['REST','EXTERNAL','INTERNAL']SearchContent Represents a set of data to put into the search index, this should represent the data of a single entity which should be indexed into the search engine NOTE: summary is the major piece of content which is being indexed, this may be an entire HTML page or just a bit of text, it is the part that will be searched when normal searches are executedTagProvider Defines the methods related to tagging entities (shared between interfaces)TagSearchProvider Deprecated.useTagProvideableandTagProviderinsteadTemplateMap An object to hold the incoming and outgoing templates in pairs, used withRedirectDefinable -
Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.entityprovider.extension Class Description ActionReturn.Header BrowseEntity This is an object to hold data about a browseable entity typeCustomAction This defines a custom entity action, this will be used to define which custom actions are allowed to be performed on entities or collections of entitiesEntityData This is an object to hold entity data (e.g. from a search which would normally return entity references), This is basically a POJO which allows us to return a few results instead of only the reference, it helps us get the entity data back more efficiently and makes it easier on developers who need to search for entitiesQuerySearch An extension of the standard search object which allows for custom constructors to make it easier to build up the search for the search queryRequestGetter Allows for getting to the request and response objects for the current threadRequestStorage This allows access to values which are stored in the current request thread, these values are inaccessible outside of a request and will be destroyed when the thread ends
This also "magically" exposes all the values in the request (attributes and params) as if they were stored in the map as well, if there are conflicts then locally stored data always wins over data from the request
Standard reserved keys have values that are always available:
_locale :Locale_requestEntityReference : String _requestActive : [true,false] _requestOrigin : ['REST','EXTERNAL','INTERNAL']RequestStorage.RequestOrigin Indicates the origin of the current requestRequestStorage.ReservedKeys Reserved keys with special data in them, seeRequestStorageSearchContent Represents a set of data to put into the search index, this should represent the data of a single entity which should be indexed into the search engine NOTE: summary is the major piece of content which is being indexed, this may be an entire HTML page or just a bit of text, it is the part that will be searched when normal searches are executedSearchResult This is a single search resultSearchResults This represents the return data from a searchTagProvider Defines the methods related to tagging entities (shared between interfaces)URLRedirect Storage for the redirects -
Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.providers Class Description ActionReturn A special object used to return specialized results from a custom action execution, includes fields to allow for handling of encoded binary data and to indicate that entity action processing should continue as it would have if there had been no custom action call (rather than exiting the standard chain)EntityData This is an object to hold entity data (e.g. from a search which would normally return entity references), This is basically a POJO which allows us to return a few results instead of only the reference, it helps us get the entity data back more efficiently and makes it easier on developers who need to search for entitiesLearningTrackingProvider This provides for tracking learning events (LRS statements) related to an entity (by prefix)
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.