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="class-use/Exportable.html#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="rowColor">
<th class="colFirst" scope="row"><a href="class-use/Inputable.html#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="class-use/Outputable.html#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="class-use/Propertyable.html#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="class-use/Redirectable.html#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="rowColor">
<th class="colFirst" scope="row"><a href="class-use/Resolvable.html#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="class-use/Sampleable.html#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="rowColor">
<th class="colFirst" scope="row"><a href="class-use/Saveable.html#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="altColor">
<th class="colFirst" scope="row"><a href="class-use/Taggable.html#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="rowColor">
<th class="colFirst" scope="row"><a href="class-use/Updateable.html#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>
<li class="blockList"><a id="org.sakaiproject.entitybroker.providers">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.sakaiproject.entitybroker.entityprovider.capabilities</a> used by <a href="../../providers/package-summary.html">org.sakaiproject.entitybroker.providers</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ActionsExecutable.html#org.sakaiproject.entitybroker.providers">ActionsExecutable</a></th>
<td class="colLast">
<div class="block">This entity supports custom actions (as defined by RoR and REST microformat:
http://microformats.org/wiki/rest/urls)<br/>
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<br/>
You can create methods in your entity provider which either end with <a href="ActionsExecutable.html#ACTION_METHOD_SUFFIX">"CustomAction"</a>
or use the <a href="../annotations/EntityCustomAction.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations"><code>EntityCustomAction</code></a> suffix to define the custom actions<br/>
You can describe the actions using the <a href="Describeable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Describeable</code></a> key: <prefix>.action.<actionKey> = description<br/>
If you want more control then you can use <a href="ActionsDefineable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>ActionsDefineable</code></a> and <a href="ActionsExecutionControllable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>ActionsExecutionControllable</code></a><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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>
]]>