|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker | |
|---|---|
| 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 type |
|
| 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 entities |
|
| PropertiesProvider
This simple defines the methods correctly which are shared between a set of interfaces, see PropertyProvideable for more information |
|
| RequestGetterWrite
Allows for getting to the request and response objects for the current thread |
|
| RequestStorageWrite
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 functionality |
|
| TagProvider
Defines the methods related to tagging entities (shared between interfaces) |
|
| Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.access | |
|---|---|
| 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 | |
|---|---|
| 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 entities |
|
| EntityProviderListener
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 use EntityProviderManager#registerNotifier(EntityProviderNotifier) to
register it with the system. |
|
| RequestGetterWrite
Allows for getting to the request and response objects for the current thread |
|
| RequestStorageWrite
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 | |
|---|---|
| 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 entities |
|
| 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 entities |
|
| Formats
Defines a list of possible format types (extensions) which can be handled and indicates which are handled internally |
|
| PropertiesProvider
This simple defines the methods correctly which are shared between a set of interfaces, see PropertyProvideable for more information |
|
| RequestGetter
Allows for getting to the request and response objects for the current thread |
|
| RequestStorage
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 executed |
|
| TagProvider
Defines the methods related to tagging entities (shared between interfaces) |
|
| TagSearchProvider
Deprecated. use TagProvideable and TagProvider instead |
|
| TemplateMap
An object to hold the incoming and outgoing templates in pairs, used with RedirectDefinable |
|
| Classes in org.sakaiproject.entitybroker.entityprovider.extension used by org.sakaiproject.entitybroker.entityprovider.extension | |
|---|---|
| ActionReturn.Header
|
|
| BrowseEntity
This is an object to hold data about a browseable entity type |
|
| 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 entities |
|
| 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 entities |
|
| QuerySearch
An extension of the standard search object which allows for custom constructors to make it easier to build up the search for the search query |
|
| RequestGetter
Allows for getting to the request and response objects for the current thread |
|
| RequestStorage
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 request |
|
| RequestStorage.ReservedKeys
Reserved keys with special data in them, see RequestStorage |
|
| 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 executed |
|
| SearchResult
This is a single search result |
|
| SearchResults
This represents the return data from a search |
|
| TagProvider
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 | |
|---|---|
| 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 entities |
|
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||