| ActionsDefineable |
This entity supports custom actions (as defined by RoR and REST microformat:
http://microformats.org/wiki/rest/urls)
This is the more controllable version, use ActionsExecutable if you
want to use the conventions and allow the system to detect your custom actions based
on method names and annotations
This means that there are custom actions which can be invoked on entities or entity spaces,
custom actions can augment the current entity operation or they can completely
change the behavior and skip the current operation entirely
You can create methods in your entity provider which either end with "CustomAction"
or use the EntityCustomAction suffix to define the custom actions
You can describe the actions using the Describeable key: .action. = description
If you want more control then you can use ActionsExecutionControllable |
| ActionsExecutable |
This entity supports custom actions (as defined by RoR and REST microformat:
http://microformats.org/wiki/rest/urls)
This means that there are custom actions which can be invoked on entities or entity spaces,
custom actions can augment the current entity operation or they can completely
change the behavior and skip the current operation entirely
You can create methods in your entity provider which either end with "CustomAction"
or use the EntityCustomAction suffix to define the custom actions
You can describe the actions using the Describeable key: .action. = description
If you want more control then you can use ActionsDefineable and ActionsExecutionControllable
|
| ActionsExecutionControllable |
This entity supports custom actions (as defined by RoR and REST microformat:
http://microformats.org/wiki/rest/urls)
This is the most complex interface for implementing custom actions but allows the most control also,
use ActionsExecutable or ActionsDefineable in most circumstance
This means that there are custom actions which can be invoked on entities or entity spaces,
custom actions can augment the current entity operation or they can completely
change the behavior and skip the current operation entirely
You can describe the actions using the Describeable key: .action. = description
You can create methods in your entity provider which either end with "CustomAction"
or use the EntityCustomAction suffix to define the custom actions
|
| AutoRegisterEntityProvider |
By implementing this interface you are telling the EntityProviderManager to register this
entity broker as soon as spring creates it, to be exposed as part of the EntityBroker
This is one of the capability extensions for the EntityProvider interface |
| Browseable |
This indicates that this entity will participate in browse functionality for entities,
For example, it will provide lists of entities which are visible to users in locations
which can be looked through and selected
This is the root interface for browsing entities and does not do anything by itself,
you must add at least BrowseableCollection or BrowseSearchable interface to this
If your entities are nested then the nested ones will need to implement BrowseNestable
Entities which do not implement this will not appear in lists of entities which are being browsed
Internationalization keys:
{prefix}.browse = the name to show in the browse list for this entity
{prefix}.browse.description = the optional description that is viable to show in the browse list for this entity
This is one of the capability extensions for the EntityProvider interface |
| BrowseableCollection |
|
| BrowseNestable |
This indicates that this entity will participate in browse functionality for entities
and it is nested within another entity: Example:
A blog (parent) contains blog entries (children).
|
| BrowseSearchable |
This indicates that this entity will participate in browse functionality for entities,
For example, it will provide lists of entities which are visible to users in locations
which can be looked through and selected
This provides fine grained control over which entities will appear in a browse list,
normally CollectionResolvable should show all entities, however, for the browse list
we will explicitly filter by users and/or locations and may not show all entities,
entities which do not implement this or BrowseableCollection will not appear in lists of entities which are being browsed
This is one of the capability extensions for the EntityProvider interface
This is the configuration interface for BrowseableCollection (the convention interface) |
| CollectionResolvable |
This type of entity supports retrieval of entities in a collection based on a search,
this will be invoked when an entity space is accessed (/prefix) rather than accessing an individual
entity (/prefix/id)
The data is returned as a list of entity objects ( Object, Map, whatever POJO, etc.) |
| Createable |
This entity type can be created (this is the C in CRUD),
the current user id should be used for permissions checking in most cases
This is one of the capability extensions for the EntityProvider interface |
| CRUDable |
A convenient interface to define that this entity type supports all CRUD operations
This is one of the capability extensions for the EntityProvider interface |
| Deleteable |
This entity type can be deleted (this is the D in CRUD),
the current user id should be used for permissions checking in most cases
This is one of the capability extensions for the EntityProvider interface |
| DepthLimitable |
This entity type can specify its own recursion depth limit.
|
| Describeable |
This entity will describe itself,
this description can be accessed for display in interfaces,
the description should generally be targeted at developers
(in particular, those using REST or web services)
This is the convention interface, it will simply look for the properties file
in the classloader which your EntityProvider is located in,
the file must be named <entity-prefix>.properties (e.g. myentity.properties)
The keys inside the file must be as follows:
<entity-prefix> = This is the main description of the entity, appears at the top
<entity-prefix>.view.<viewKey> = This is a description about a particular view for an entity (viewKey from entity view constants EntityView.VIEW_LIST)
<entity-prefix>.action.<actionKey> = This is a description of a custom action for this entity (see ActionsExecutable or EntityCustomAction)
<entity-prefix>.field.<fieldName> = This is a description about a particular entity field for this entity object (see Resolvable or CollectionResolvable)
<entity-prefix>.redirect.<redirectTemplate> = This is a description about a particular redirect rule for this entity URL space (see Redirectable or EntityURLRedirect)
<entity-prefix>.<capability> = This is a description about a particular capability for this entity
Example:<![CDATA[
myentity = This is my entity, it is used for <b>examples</b> only
myentity.view.show = this shows a single instance of my entity
myentity.action.copy = this makes a copy of an instance of a myentity
myentity.field.name = this is the name of the entity, it is a user displayable name
myentity.redirect.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DescribeDefineable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">DescribeDefineable</a></th>
<td class="colLast">
<div class="block">Allows an entity to define the description of itself in code rather than using properties,
this will be called each time a description is needed so it should be efficient<br/>
This is the configuration interface<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DescribePropertiesable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">DescribePropertiesable</a></th>
<td class="colLast">
<div class="block">This allows an entity to define the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Properties</code></a> files/classes to be used
for looking up descriptions of the entity (<a href="Describeable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Describeable</code></a>)<br/>
This is the configuration interface<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EntityViewUrlCustomizable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">EntityViewUrlCustomizable</a></th>
<td class="colLast">
<div class="block">Indicates that the entity URLs for the types of entities handled by this provider
are customized by the set of entity templates returned<br/>
These will be used</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Exportable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Exportable</a></th>
<td class="colLast">
<div class="block">Indicates an entity provider has the capability of exporting entity data which is related to
other entities, note that the decision about which data to export is left up to the implementor
based on the reference supplied <br/> This is one of the capability extensions for the
<a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Importable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Importable</a></th>
<td class="colLast">
<div class="block">Indicates an entity provider has the capability of importing entity data that was previously
exported via the <a href="Exportable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Exportable</code></a> capability which will be related to other entities, note that
the way to associate the data is left up to the implementor based on the reference supplied <br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Inputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Inputable</a></th>
<td class="colLast">
<div class="block">These entities can be entered as certain input formats which are handled automatically
and translated into entity objects (of the type defined by <a href="Sampleable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Sampleable</code></a>)<br/>
If you want to define the way the input is translated instead of using the internal methods
then use <a href="InputTranslatable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>InputTranslatable</code></a><br/>
<br/>
<b>NOTE:</b> By default all entity view requests go through to the available access providers:
<a href="../../access/EntityViewAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access"><code>EntityViewAccessProvider</code></a> or <code>HttpServletAccessProvider</code></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InputTranslatable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">InputTranslatable</a></th>
<td class="colLast">
<div class="block">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 <a href="Inputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Inputable</code></a><br/>
NOTE: throwing <a href="../../exception/FormatUnsupportedException.html" title="class in org.sakaiproject.entitybroker.exception"><code>FormatUnsupportedException</code></a> 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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a> and the processing will be halted</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LearningTrackable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">LearningTrackable</a></th>
<td class="colLast">
<div class="block">This capability is for tracking learning events (LRS statements) related to this entity<br/>
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Outputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Outputable</a></th>
<td class="colLast">
<div class="block">These entities can be returned as certain output formats which are handled automatically<br/>
If you want to define the data that is returned instead of using the internal methods
then use <a href="OutputFormattable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>OutputFormattable</code></a><br/>
<br/>
<b>NOTE:</b> By default all entity view requests go through to the available access providers:
<a href="../../access/EntityViewAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access"><code>EntityViewAccessProvider</code></a> or <code>HttpServletAccessProvider</code>
<b>NOTE:</b> 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)</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OutputFormattable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">OutputFormattable</a></th>
<td class="colLast">
<div class="block">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 <a href="Outputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Outputable</code></a><br/>
NOTE: throwing <a href="../../exception/FormatUnsupportedException.html" title="class in org.sakaiproject.entitybroker.exception"><code>FormatUnsupportedException</code></a> 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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a> and the processing will be halted</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OutputSerializable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">OutputSerializable</a></th>
<td class="colLast">
<div class="block">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 <a href="Outputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Outputable</code></a><br/></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Propertyable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Propertyable</a></th>
<td class="colLast">
<div class="block">Allows entities handled by the entity provider which implements this interface to have meta properties
attached to them, properties can be accessed via the <code>EntityBroker</code>, properties will be
stored and retrieved using the internal entity property retrieval implementation<br/>
For our usage, meta properties are extra or additional properties that are attached to an entity
at runtime but are persisted so they can be retrieved later<br/>
<b>WARNING:</b> this should be used only for properties of entities which will be accessed very
lightly, for production level access OR the ability to control how properties are stored on your
own entities, you should use the <a href="PropertyProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>PropertyProvideable</code></a> instead <br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PropertyProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">PropertyProvideable</a></th>
<td class="colLast">
<div class="block">Allows entities handled by the entity provider which implements this interface to have meta properties
attached to them, these properties can be accessed via the <a href="../../EntityBroker.html" title="interface in org.sakaiproject.entitybroker"><code>EntityBroker</code></a>, properties will be
stored and retrieved via the methods which are implemented in this interface<br/>
For our usage, meta properties are extra or additional properties that are attached to an entity
at runtime but are persisted so they can be retrieved later<br/>
Allows the entity provider to define and control the way properties are stored on its own entities,
if you would prefer to use the internal storage and only have lightweight property storage needs
then use <a href="Propertyable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Propertyable</code></a> instead<br/>
<b>NOTE:</b> the validity of references and parameters is checked in the broker before the call
goes to the provider <br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Redirectable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Redirectable</a></th>
<td class="colLast">
<div class="block">This entity type has the ability to define and handle configurable URLs,
URLs like this can be handled and supported:<br/>
/gradebook/7890/student/70987 to view all the grades for a student from a course <br/>
/gradebook/6758/item/Quiz1 to view a particular item in a gradebook by it's human readable name <br/>
/gradebook/item/6857657 to maybe just a view an item by its unique id.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RedirectControllable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RedirectControllable</a></th>
<td class="colLast">
<div class="block">This entity type has the ability to define and handle configurable URLs<br/>
This adds the ability to control all redirects via a central method<br/>
URLs like this can be handled and supported:<br/>
/gradebook/7890/student/70987 to view all the grades for a student from a course <br/>
/gradebook/6758/item/Quiz1 to view a particular item in a gradebook by it's human readable name <br/>
/gradebook/item/6857657 to maybe just a view an item by its unique id.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RedirectDefinable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RedirectDefinable</a></th>
<td class="colLast">
<div class="block">This entity type has the ability to define and handle configurable URLs<br/>
This adds the ability to supply a large set of simple redirects<br/>
URLs like this can be handled and supported:<br/>
/gradebook/7890/student/70987 to view all the grades for a student from a course <br/>
/gradebook/6758/item/Quiz1 to view a particular item in a gradebook by it's human readable name <br/>
/gradebook/item/6857657 to maybe just a view an item by its unique id.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ReferenceParseable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">ReferenceParseable</a></th>
<td class="colLast">
<div class="block">Indicates an entity provider has the capability of parsing its own reference string.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RequestAware.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestAware</a></th>
<td class="colLast">
<div class="block">Indicates that this entity provider needs to be request aware,
this allows the entity provider to get hold of information from the request at any time
by directly accessing the request and response objects (if we are inside a request),
if there is no current request then this method will fail to return anything<br/>
This is primarily intended to provide access to request parameters while operating
inside the entity provider</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RequestHandler.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestHandler</a></th>
<td class="colLast">
<div class="block">Indicates that this entity provider will handle its own entity view requests,
this would be very unusual but it allows the entity provider itself to redirect
requests to a tool and normally would be used if there is some special circumstance only<br/>
<b>WARNING:</b> This will be called before any other request handling and before the access provider
is called and will cause all other processing to be skipped (includes REST calls, custom actions, formatting, etc.)<br/>
<br/>
<b>NOTE:</b> if you want to stop certain requests from coming through then
a better option is to use <a href="RequestInterceptor.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RequestInterceptor</code></a> which is triggered
just before this would be called</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RequestInterceptor.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestInterceptor</a></th>
<td class="colLast">
<div class="block">Allows actions to be taken before a direct request is handled or after it has been handled,
will only affect requests coming in via the direct servlet</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RequestStorable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestStorable</a></th>
<td class="colLast">
<div class="block">Indicates that this entity provider is aware of the requests and can get to
the stored values in the request or can store its own,
this allows the entity provider to get hold of information from the request at any time<br/>
This is primarily intended to provide access to request data while operating
inside the entity provider without depending on servlet knowledge<br/>
This provides access to the special indicator values which can be used to see
what kind of request is operating and get information about it,
see the <a href="../extension/RequestStorage.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension"><code>RequestStorage</code></a> object for more info<br/>
If you need to get to the servlet data see <a href="RequestAware.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RequestAware</code></a> and <a href="RequestInterceptor.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RequestInterceptor</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Resolvable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Resolvable</a></th>
<td class="colLast">
<div class="block">Allows the entities handled by this provider to be accessed directly as objects,
this is also the interface for "reading" entities (this is the R in CRUD)<br/>
This is also used for resolving the type of entities<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTful.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RESTful</a></th>
<td class="colLast">
<div class="block">Indicates that entities handled by this provider are RESTful as defined by the REST microformat:<br/>
<a href="http://microformats.org/wiki/rest/urls">http://microformats.org/wiki/rest/urls</a><br/>
Requires all CRUD functionality, Collection handling, HTML handling, and ability to support output formats<br/>
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</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Sampleable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Sampleable</a></th>
<td class="colLast">
<div class="block">This entity type can be known and this allows access to a sample object which represents it,
the sample object can be of any type including a POJO, a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a>, etc.<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Saveable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Saveable</a></th>
<td class="colLast">
<div class="block">Convenience interface to indicates that an entity is can be saved,
i.e. it is creatable and updateable</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Searchable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Searchable</a></th>
<td class="colLast">
<div class="block">Indicates an entity provider has the capability of allowing the entities associated with it to be searchable,
entities which implement this will be linked to the core search functionality <br/>
If you need to force an entity or entities to be added to the search indexes then you should use the
<a href="../extension/SearchProvider.html#add(java.lang.String,org.sakaiproject.entitybroker.entityprovider.extension.SearchContent)"><code>SearchProvider.add(String, org.sakaiproject.entitybroker.entityprovider.extension.SearchContent)</code></a>
method in the system core to cause immediate indexing
<br/> This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Statisticable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Statisticable</a></th>
<td class="colLast">
<div class="block">This capability is for tracking statistics of events for entities related to a tool,
it will be used by the site stats service for event tracking and reporting<br/>
Contact Nuno Fernandes (nuno@ufp.edu.pt) if you have questions<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Taggable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Taggable</a></th>
<td class="colLast">
<div class="block">Allows an entity to have tags associated with it which can be searched for or simply used as a
way to link to this entity <br/>
This uses the internal tag storage mechanism or a central tag storage mechanism
to store the tag applications<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TagProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">TagProvideable</a></th>
<td class="colLast">
<div class="block">Allows an entity to control and provide tag storage and searching,
this overrides internal tag storage and any existing tag storage will
be ignored in favor of the provided tags<br/>
This is the provider interface for <a href="Taggable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Taggable</code></a>, inherits all methods from <a href="../extension/TagProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension"><code>TagProvider</code></a><br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TagSearchable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">TagSearchable</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">no longer functional, use <a href="TagProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>TagProvideable</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Updateable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Updateable</a></th>
<td class="colLast">
<div class="block">This entity type can be updated (this is the U in CRUD),
the current user id should be used for permissions checking in most cases<br/>
This is one of the capability extensions for the <a href="../EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright © 2023. All rights reserved.</small></p>
</footer>
</body>
</html>
]]> |