All Classes (Sakai Entity Broker API 22.3 API)

All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class	Description
AccessFormats	Indicates that entity requests can be handled for certain formats which are indicated NOTE: By default all entity view requests go through to the available access providers: `EntityViewAccessProvider` or `HttpServletAccessProvider` if nothing is specified here or this interface is not implemented
AccessViews	Indicates that entity requests can be handled for certain views which are indicated NOTE: By default all entity view requests go through to the available access providers: `EntityViewAccessProvider` or `HttpServletAccessProvider` if nothing is specified here or this interface is not implemented
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)
ActionReturn.Header
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
AutoRegister	By implementing this interface you are telling the system to pick up all the objects which are implementing this interface and put them in a bucket so they will be loaded into any bean which implements BeanCollector and asks for them
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
BeanCollector<T>	Implement this in order to cause spring to inject a set of beans into your spring bean (if any exist) which implement the interface you define (they will also have to implement `AutoRegister`)
BeanMapCollector	Implement this in order to cause spring to inject a map of type -> a set of beans into your spring bean (if any exist) which implement the type interfaces you define (those interfaces will also have to implement `AutoRegister`)
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	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 Entities which do not implement this will not appear in lists of entities which are being browsed This is the convention interface and simply uses the results of calls to `CollectionResolvable` to provide lists of entities for browsing, the implementor should be sure that ordering and limiting are supported for the provided search object in their implementation of `CollectionResolvable.getEntities(org.sakaiproject.entitybroker.EntityReference, org.sakaiproject.entitybroker.entityprovider.search.Search)` This is one of the capability extensions for the `EntityProvider` interface See `Browseable` for the i18n keys This extends `CollectionResolvable`, use the `BrowseSearchable` interface if you require more control
BrowseEntity	This is an object to hold data about a browseable entity type
BrowseEntity.PrefixComparator
BrowseEntity.TitleComparator
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)
ClassLoaderReporter	Allows a bean to report the classloader that is appropriate for it and will be used for dispatching into this beans environment, this is only needed in advanced cases and should not normally be implemented The primary use case here is to allow someone to set their classloader when they are using a proxied bean or the implementation class is in the wrong classloader This is primarily used in the case of the `HttpServletAccessProvider` or `EntityViewAccessProvider` and the implementations of those should also implement this interface to be able to specify the classloader
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.)
CoreEntityProvider	This is the base unit for working with Sakai entities, by implementing this interface and creating a spring bean you will tie your entities into Sakai, there are many other interfaces which you can implement to extend the interaction of your entities with Sakai in this package You (the implementor) will want to create one implementation of this interface for each type of entity you want to link to Sakai to track events, provide URL access, etc. Usage: 1) Implement this interface 2) Implement any additional capabilities interfaces (optional) 3) Create a spring bean definition in the Sakai application context (components.xml) 4) Implement `AutoRegisterEntityProvider` or register this implementation some other way Recommended best practices: (example: Thing entity) 1) Create an interface called ThingEntityProvider which extends `EntityProvider` in api logic (add an entity package for it), (e.g. org.sakaiproject.evaluation.logic.entity.EvaluationEntityProvider.java) 2) Add a public static string which contains the entity prefix (called ENTITY_PREFIX), (e.g. public final static String ENTITY_PREFIX = "eval-evaluation";) 3) Implement your ThingEntityProvider in impl logic as ThingEntityProviderImpl (add an entity package for it), (e.g.
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
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
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:

AccessFormats

Indicates that entity requests can be handled for certain formats which are indicated

NOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider if nothing is specified here or this interface is not implemented

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)

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

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

BeanMapCollector

Implement this in order to cause spring to inject a map of type -> a set of beans into your spring bean (if any exist) which implement the type interfaces you define (those interfaces will also have to implement AutoRegister)

BrowseableCollection

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
Entities which do not implement this will not appear in lists of entities which are being browsed
This is the convention interface and simply uses the results of calls to CollectionResolvable to provide lists of entities for browsing, the implementor should be sure that ordering and limiting are supported for the provided search object in their implementation of

CollectionResolvable.getEntities(org.sakaiproject.entitybroker.EntityReference, org.sakaiproject.entitybroker.entityprovider.search.Search)

This is one of the capability extensions for the EntityProvider interface
See Browseable for the i18n keys
This extends CollectionResolvable, use the BrowseSearchable interface if you require more control

BrowseEntity.PrefixComparator

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).

ClassLoaderReporter

Allows a bean to report the classloader that is appropriate for it and will be used for dispatching into this beans environment, this is only needed in advanced cases and should not normally be implemented
The primary use case here is to allow someone to set their classloader when they are using a proxied bean or the implementation class is in the wrong classloader
This is primarily used in the case of the HttpServletAccessProvider or EntityViewAccessProvider and the implementations of those should also implement this interface to be able to specify the classloader

CoreEntityProvider

This is the base unit for working with Sakai entities, by implementing this interface and creating a spring bean you will tie your entities into Sakai, there are many other interfaces which you can implement to extend the interaction of your entities with Sakai in this package
You (the implementor) will want to create one implementation of this interface for each type of entity you want to link to Sakai to track events, provide URL access, etc.

Usage:
1) Implement this interface
2) Implement any additional capabilities interfaces (optional)
3) Create a spring bean definition in the Sakai application context (components.xml)
4) Implement AutoRegisterEntityProvider or register this implementation some other way

Recommended best practices: (example: Thing entity)
1) Create an interface called ThingEntityProvider which extends EntityProvider in api logic (add an entity package for it), (e.g. org.sakaiproject.evaluation.logic.entity.EvaluationEntityProvider.java)
2) Add a public static string which contains the entity prefix (called ENTITY_PREFIX), (e.g. public final static String ENTITY_PREFIX = "eval-evaluation";)
3) Implement your ThingEntityProvider in impl logic as ThingEntityProviderImpl (add an entity package for it), (e.g.

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

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: 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> </th> </tr> <tr id="i27" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/DescribeDefineable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">DescribeDefineable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i28" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/DescribePropertiesable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">DescribePropertiesable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i29" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/DeveloperHelperService.html" title="interface in org.sakaiproject.entitybroker">DeveloperHelperService</a></td> <th class="colLast" scope="row"> <div class="block">Includes methods which are likely to be helpful to developers who are implementing entity providers in Sakai and working with references</div> </th> </tr> <tr id="i30" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/EntityBroker.html" title="interface in org.sakaiproject.entitybroker">EntityBroker</a></td> <th class="colLast" scope="row"> <div class="block">This service interface defines the capabilities of the entity broker system<br/> It allows Sakai system methods, developers, etc. to access Sakai entity information (new and old)</div> </th> </tr> <tr id="i31" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/exception/EntityBrokerException.html" title="class in org.sakaiproject.entitybroker.exception">EntityBrokerException</a></td> <th class="colLast" scope="row"> <div class="block">The base class for all exceptions out of the entity broker system</div> </th> </tr> <tr id="i32" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/EntityBrokerManager.html" title="interface in org.sakaiproject.entitybroker">EntityBrokerManager</a></td> <th class="colLast" scope="row"> <div class="block">The core of the EB system, this is generally not for use by developers and is mostly for internal use but it should be ok to use most of these methods</div> </th> </tr> <tr id="i33" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityContent.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityContent</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the main content text for an entity, Example: the main text body for a blog entry or email, the main content of an article or posting, the convention is to run toString on the return from the "getContent" method or the value in the "content" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i34" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityCustomAction.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityCustomAction</a></td> <th class="colLast" scope="row"> <div class="block">This annotation indicates that this method is a custom action from <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/ActionsExecutable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>ActionsExecutable</code></a>, this should not be placed on any methods defined by a capability but should be placed on methods which you want to be exposed as custom actions<br/> By default the name of the method is used as the action key and this will work for read requests (viewKey is set to <a href="org/sakaiproject/entitybroker/EntityView.html#VIEW_SHOW"><code>EntityView.VIEW_SHOW</code></a>), you can add in action and viewKey annotation params to change those settings<br/> You can describe this action using the key: <prefix>.action.<actionKey> = description<br/> The methods annotated by this can have the following argument (parameter) types: <br/> (type => data which will be given to the method) <br/> <a href="org/sakaiproject/entitybroker/EntityView.html" title="class in org.sakaiproject.entitybroker"><code>EntityView</code></a> : the current entity view for this request (contains extension, url, segments) <br/> <a href="org/sakaiproject/entitybroker/EntityReference.html" title="class in org.sakaiproject.entitybroker"><code>EntityReference</code></a> : the current entity reference (prefix and optional id) <br/> <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> : entity prefix <br/> <code>Search</code> : the search object based on the incoming params <br/> <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> : stream to place outbound data (probably binary) into for transmission <br/> <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> (<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> => <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Object</code></a>) : a map of the actions parameters (params from the action request) <br/> <br/> These methods should return one of the following: <br/> 1) null (this is ok in most circumstances to indicate the method is done, use an exception to indicate failure) <br/> 2) an <a href="org/sakaiproject/entitybroker/entityprovider/extension/ActionReturn.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension"><code>ActionReturn</code></a> (this is a special object used to indicate return states and handle binary data) <br/> 3) an <code>EntityData</code> (this is a special object used to wrap the object and provide meta data) <br/> 4) a UTF-8 encoded OutputStream or String <br/> 5) a List of entity objects <br/> 6) an entity object <br/> 7) a boolean value (true indicates success and is the same as returning null, false indicates failure and causes an <a href="org/sakaiproject/entitybroker/exception/EntityNotFoundException.html" title="class in org.sakaiproject.entitybroker.exception"><code>EntityNotFoundException</code></a> <br/> <br/> Can throw the following exceptions and have them translated and handled, all others will pass through:<br/> <a href="org/sakaiproject/entitybroker/exception/EntityNotFoundException.html" title="class in org.sakaiproject.entitybroker.exception"><code>EntityNotFoundException</code></a> to indicate the entity request could not find the data that was requested <br/> <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalArgumentException</code></a> to indicate that the incoming params or the request was invalid <br/> <a href="org/sakaiproject/entitybroker/exception/FormatUnsupportedException.html" title="class in org.sakaiproject.entitybroker.exception"><code>FormatUnsupportedException</code></a> to indicate that the requested format is not supported for this entity request <br/> <a href="org/sakaiproject/entitybroker/exception/EntityException.html" title="class in org.sakaiproject.entitybroker.exception"><code>EntityException</code></a> to indicate a specific entity failure occurred, can include a response code and error message <br/> <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>SecurityException</code></a> to indicate that the the current user is no allowed to perform this action <br/> <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>UnsupportedOperationException</code></a> to indicate that the current action being requested is invalid (typically indicates bad combination of viewKey and action) <br/> <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> to indicate a general failure has occurred <br/> <br/></div> </th> </tr> <tr id="i35" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/EntityData.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">EntityData</a></td> <th class="colLast" scope="row"> <div class="block">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</div> </th> </tr> <tr id="i36" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/EntityData.ReferenceComparator.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">EntityData.ReferenceComparator</a></td> <th class="colLast" scope="row"> </th> </tr> <tr id="i37" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/EntityData.TitleComparator.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">EntityData.TitleComparator</a></td> <th class="colLast" scope="row"> </th> </tr> <tr id="i38" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityDateCreated.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityDateCreated</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the date created time code (unix time code) for an entity, this can be a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Date</code></a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Long</code></a>, long, or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> (will attempt to convert this to a long)<br/> the convention is to try to convert the return from the "getDateCreated" method or the value in the "dateCreated" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i39" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/exception/EntityEncodingException.html" title="class in org.sakaiproject.entitybroker.exception">EntityEncodingException</a></td> <th class="colLast" scope="row"> <div class="block">Throw to indicate that there was a failure during encoding/decoding an entity or related data</div> </th> </tr> <tr id="i40" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/exception/EntityException.html" title="class in org.sakaiproject.entitybroker.exception">EntityException</a></td> <th class="colLast" scope="row"> <div class="block">This exception is used to indicate that a problem occurred attempting to get an entity, the reference to the failed entity should be returned in the exception along with the response code which is indicative of the failure (if possible) HTTP Response Codes (http://en.wikipedia.org/wiki/List_of_HTTP_status_codes)<br/> <b>Client Error</b><br/> 400 Bad Request The request could not be understood by the server due to malformed syntax.</div> </th> </tr> <tr id="i41" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityFieldRequired.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityFieldRequired</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as required to be non-null and non-empty for an entity, this can be used many times in a class, this is mostly for documentation purposes and has little effect on operations</div> </th> </tr> <tr id="i42" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityHttpParam.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityHttpParam</a></td> <th class="colLast" scope="row"> <div class="block">This annotation indicates that this method parameter should be replaced by the value in the HTTP query parameter, header, or form parameter whose name matches the name set in the annotation <br/> Binds the value(s) of a HTTP query parameter to a resource method parameter.</div> </th> </tr> <tr id="i43" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityId.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityId</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the unique local Id for an entity, the convention is to run toString on the return from the "getId" method or the value in the "id" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i44" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityLastModified.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityLastModified</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the last modified time code (unix time code) for an entity, this can be a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Date</code></a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Long</code></a>, long, or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> (will attempt to convert this to a long)<br/> the convention is to try to convert the return from the "getLastModified" method or the value in the "lastModified" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i45" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityModifiedBy.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityModifiedBy</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the user ref of the last user to modify an entity<br/> the convention is to run toString on the return from the "getModifiedBy" method or the value in the "modifiedBy" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i46" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/exception/EntityNotFoundException.html" title="class in org.sakaiproject.entitybroker.exception">EntityNotFoundException</a></td> <th class="colLast" scope="row"> <div class="block">Throw to indicate that there was a failure finding an entity or collection of entities</div> </th> </tr> <tr id="i47" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityOwner.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityOwner</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the user ref of the creator/owner of an entity, the convention is to run toString on the return from the "getOwner" method or the value in the "owner" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i48" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityParameters.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityParameters</a></td> <th class="colLast" scope="row"> <div class="block">This annotation indicates that this method is accepts or expects certain parameters to be present before it can be executed, these parameters are accessible in the params map <br/> Any parameters included in this annotation can be documented using the i18n properties files by placing a message at: prefix.action.actionname.field.fieldname OR prefix.view.viewkey.field.fieldname <br/> NOTE: there is no need to list the field names of the fields which are included in the entity class or map here, this is for additional parameters only <br/> <br/></div> </th> </tr> <tr id="i49" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/providers/EntityPropertiesService.html" title="interface in org.sakaiproject.entitybroker.providers">EntityPropertiesService</a></td> <th class="colLast" scope="row"> <div class="block">This provides the entity system with a way to access properties (and then exposes this to others via the developer helper service)</div> </th> </tr> <tr id="i50" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider">EntityProvider</a></td> <th class="colLast" scope="row"> <div class="block">Beans may implement this interface directly to provide "extension" capabilities to an existing <a href="org/sakaiproject/entitybroker/entityprovider/CoreEntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>CoreEntityProvider</code></a>.</div> </th> </tr> <tr id="i51" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/EntityProviderListener.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">EntityProviderListener</a><<a href="org/sakaiproject/entitybroker/entityprovider/extension/EntityProviderListener.html" title="type parameter in EntityProviderListener">T</a> extends <a href="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider">EntityProvider</a>></td> <th class="colLast" scope="row"> <div class="block">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<br/> Usage:<br/> Just implement this class and use <code>EntityProviderManager#registerNotifier(EntityProviderNotifier)</code> to register it with the system.</div> </th> </tr> <tr id="i52" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/EntityProviderManager.html" title="interface in org.sakaiproject.entitybroker.entityprovider">EntityProviderManager</a></td> <th class="colLast" scope="row"> <div class="block">Handles all internal work of managing and working with the entity providers<br/> <br/> Registration of entity brokers happens via spring, see the <a href="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface for details</div> </th> </tr> <tr id="i53" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/EntityProviderMethodStore.html" title="interface in org.sakaiproject.entitybroker.entityprovider">EntityProviderMethodStore</a></td> <th class="colLast" scope="row"> <div class="block">This is the interface for handling storage of methods (related to custom actions and the like), this is for internal usage only and should not be accessed or used by other developers</div> </th> </tr> <tr id="i54" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/EntityReference.html" title="class in org.sakaiproject.entitybroker">EntityReference</a></td> <th class="colLast" scope="row"> <div class="block">The class of all Entity references handled by the EntityBroker system.</div> </th> </tr> <tr id="i55" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/providers/EntityRequestHandler.html" title="interface in org.sakaiproject.entitybroker.providers">EntityRequestHandler</a></td> <th class="colLast" scope="row"> <div class="block">Handles the URL/request processing for an entity in a central location</div> </th> </tr> <tr id="i56" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/util/EntityResponse.html" title="class in org.sakaiproject.entitybroker.util">EntityResponse</a></td> <th class="colLast" scope="row"> <div class="block">This is here to contain the information we get back from an entity (http) request fired by the <a href="org/sakaiproject/entitybroker/EntityBroker.html#fireEntityRequest(java.lang.String,java.lang.String,java.lang.String,java.util.Map,java.lang.Object)"><code>EntityBroker.fireEntityRequest(String, String, String, Map, Object)</code></a> method<br/> This object and the data in it should be considered immutable</div> </th> </tr> <tr id="i57" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/providers/EntityRESTProvider.html" title="interface in org.sakaiproject.entitybroker.providers">EntityRESTProvider</a></td> <th class="colLast" scope="row"> <div class="block">Handles anything REST based that is not part of the core EB registration piece</div> </th> </tr> <tr id="i58" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntitySummary.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntitySummary</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the summary or description text for an entity, Example: the summary for a blog entry or email, the instructions text for a test or survey the convention is to run toString on the return from the "getSummary" method or the value in the "summary" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i59" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityTitle.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityTitle</a></td> <th class="colLast" scope="row"> <div class="block">Marks a getter method or field as the display title for an entity, the convention is to run toString on the return from the "getTitle" method or the value in the "title" field<br/> <b>NOTE:</b> This annotation should only be used once in a class, the getter method must take no arguments and return an object</div> </th> </tr> <tr id="i60" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/annotations/EntityURLRedirect.html" title="annotation in org.sakaiproject.entitybroker.entityprovider.annotations">EntityURLRedirect</a></td> <th class="colLast" scope="row"> <div class="block">This annotation indicates that this method will handle an incoming URL and do some processing to turn it into an outgoing URL OR just do some processing OR indicate that a failure has occurred<br/> Define the URL pattern to match AFTER the /prefix using {name} to indicate variables <br/> Example: /{thing}/site/{siteId} will match the following URL: <br/> /myprefix/123/site/456, the variables will be {prefix => myprefix, thing => 123, siteId => 456}<br/> NOTE: all incoming URL templates must start with "/{prefix}" (<a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#TEMPLATE_PREFIX"><code>TemplateParseUtil.TEMPLATE_PREFIX</code></a>) <br/> <br/> NOTE: The method template patterns will be compared in the order they appear in your source code so be careful that you do not have a really simple redirect pattern as the first one as this can cause the other patterns to never be reached<br/> The methods that this annotates should return a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> or void<br/> They can have the following parameter types: <br/> (type => data which will be given to the method) <br/> <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> : incoming URL <br/> <a href="org/sakaiproject/entitybroker/EntityView.Method.html" title="enum in org.sakaiproject.entitybroker"><code>EntityView.Method</code></a> : the submission method (GET,POST,etc) <br/> String[] : incoming URL segments, Example: /myprefix/123/apple => {'prefix','123','apple'} <br/> <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> (<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> => <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a>) : a map of the variable values in the {}, Example: pattern: /{prefix}/{thing}/apple, url: /myprefix/123/apple, would yield: {'thing' => '123','prefix' => 'mypreifx'} <br/> Don't forget to handle the extensions as they will not automatically pass through, use the <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#DOT_EXTENSION"><code>TemplateParseUtil.DOT_EXTENSION</code></a> and <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#EXTENSION"><code>TemplateParseUtil.EXTENSION</code></a> values from the variable map which will contain the extension that was passed in <br/> <br/> Return should be one of the following: <br/> 1) the URL to redirect to, will be processed as an external redirect if it starts with "http" or "/" (unless it starts with "/{prefix}"), otherwise it will be processed as an internal forward <br/> 2) "" (empty string) to not redirect and return an empty success response <br/> 3) null to not redirect and allow standard processing of the URL to continue <br/> For failures: if there is a failure you should throw an IllegalStateException to indicate failure <br/> This is the convention part of the <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Redirectable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Redirectable</code></a> capability<br/></div> </th> </tr> <tr id="i61" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/EntityView.html" title="class in org.sakaiproject.entitybroker">EntityView</a></td> <th class="colLast" scope="row"> <div class="block">Defines an entity view (a specific way to looking at entity data, e.g.</div> </th> </tr> <tr id="i62" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/EntityView.Method.html" title="enum in org.sakaiproject.entitybroker">EntityView.Method</a></td> <th class="colLast" scope="row"> <div class="block">Represents HTTP methods (GET, POST, etc.)</div> </th> </tr> <tr id="i63" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/access/EntityViewAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access">EntityViewAccessProvider</a></td> <th class="colLast" scope="row"> <div class="block">Represents a bean which is capable of handling access for an <a href="org/sakaiproject/entitybroker/EntityView.html" title="class in org.sakaiproject.entitybroker"><code>EntityView</code></a>, this replaces the <a href="org/sakaiproject/entitybroker/access/HttpServletAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access"><code>HttpServletAccessProvider</code></a> as all entity URLs are now being parsed so more information can be provided through the <a href="org/sakaiproject/entitybroker/EntityView.html" title="class in org.sakaiproject.entitybroker"><code>EntityView</code></a><br/> <br/> This interface would be typically implemented from a tool (webapp) context, and registered with the <a href="org/sakaiproject/entitybroker/access/EntityViewAccessProviderManager.html" title="interface in org.sakaiproject.entitybroker.access"><code>EntityViewAccessProviderManager</code></a> in a context loader listener<br/> <br/> If the implementation throws a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>SecurityException</code></a> during the course of this method, the access will be directed to a login page or authentication method before being redirected back to the implementation method<br/> If you want to control the requests which make it through to this by format type you can optionally implement <a href="org/sakaiproject/entitybroker/access/AccessFormats.html" title="interface in org.sakaiproject.entitybroker.access"><code>AccessFormats</code></a></div> </th> </tr> <tr id="i64" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/access/EntityViewAccessProviderManager.html" title="interface in org.sakaiproject.entitybroker.access">EntityViewAccessProviderManager</a></td> <th class="colLast" scope="row"> <div class="block">Manages all the access providers for the entity views in the system<br/> Use this to register yourself as handling the entity views for a set of entites (based on the prefix) This will be used by the entity broker to determine if anyone is handling entity views for an entity type</div> </th> </tr> <tr id="i65" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/EntityViewUrlCustomizable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">EntityViewUrlCustomizable</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i66" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/event/EventReceiver.html" title="interface in org.sakaiproject.entitybroker.event">EventReceiver</a></td> <th class="colLast" scope="row"> <div class="block">Allows a developer to create a method which will be called when specific events occur by implementing this interface, this uses the Sakai event services</div> </th> </tr> <tr id="i67" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Exportable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Exportable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i68" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/providers/ExternalIntegrationProvider.html" title="interface in org.sakaiproject.entitybroker.providers">ExternalIntegrationProvider</a></td> <th class="colLast" scope="row"> </th> </tr> <tr id="i69" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/Formats.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">Formats</a></td> <th class="colLast" scope="row"> <div class="block">Defines a list of possible format types (extensions) which can be handled and indicates which are handled internally</div> </th> </tr> <tr id="i70" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/exception/FormatUnsupportedException.html" title="class in org.sakaiproject.entitybroker.exception">FormatUnsupportedException</a></td> <th class="colLast" scope="row"> <div class="block">Throw to indicate that there was a failure during formatting an entity (input or output), use the message to indicate more information about the failure, place the reference and format into the exception</div> </th> </tr> <tr id="i71" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/access/HttpServletAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access">HttpServletAccessProvider</a></td> <th class="colLast" scope="row">Deprecated. <div class="deprecationComment">Use <a href="org/sakaiproject/entitybroker/access/EntityViewAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access"><code>EntityViewAccessProvider</code></a> instead</div> </th> </tr> <tr id="i72" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/access/HttpServletAccessProviderManager.html" title="interface in org.sakaiproject.entitybroker.access">HttpServletAccessProviderManager</a></td> <th class="colLast" scope="row">Deprecated. <div class="deprecationComment">Use <a href="org/sakaiproject/entitybroker/access/EntityViewAccessProviderManager.html" title="interface in org.sakaiproject.entitybroker.access"><code>EntityViewAccessProviderManager</code></a> instead</div> </th> </tr> <tr id="i73" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/IdEntityReference.html" title="class in org.sakaiproject.entitybroker">IdEntityReference</a></td> <th class="colLast" scope="row">Deprecated. <div class="deprecationComment">Use <a href="org/sakaiproject/entitybroker/EntityReference.html" title="class in org.sakaiproject.entitybroker"><code>EntityReference</code></a> directly, this will be removed eventually</div> </th> </tr> <tr id="i74" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Importable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Importable</a></td> <th class="colLast" scope="row"> <div class="block">Indicates an entity provider has the capability of importing entity data that was previously exported via the <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i75" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Inputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Inputable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/access/EntityViewAccessProvider.html" title="interface in org.sakaiproject.entitybroker.access"><code>EntityViewAccessProvider</code></a> or <code>HttpServletAccessProvider</code></div> </th> </tr> <tr id="i76" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/InputTranslatable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">InputTranslatable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/Inputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Inputable</code></a><br/> NOTE: throwing <a href="org/sakaiproject/entitybroker/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> </th> </tr> <tr id="i77" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/LearningTrackable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">LearningTrackable</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i78" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/LearningTrackingProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">LearningTrackingProvider</a></td> <th class="colLast" scope="row"> <div class="block">This provides for tracking learning events (LRS statements) related to an entity (by prefix)<br/> If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.</div> </th> </tr> <tr id="i79" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/search/Order.html" title="class in org.sakaiproject.entitybroker.entityprovider.search">Order</a></td> <th class="colLast" scope="row"> <div class="block">A simple bean which defines the order to return the results of a search<br/> Example usage:<br/> <code>Order ota = new Order("title"); // order by title ascending</code><br/> <code>Order otd = new Order("title", false); // order by title descending</code><br/></div> </th> </tr> <tr id="i80" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/collector/OrderedBean.html" title="interface in org.sakaiproject.entitybroker.collector">OrderedBean</a></td> <th class="colLast" scope="row"> <div class="block">This sets the order of a bean when it is grabbed by the bean collector and ensures a guaranteed priority order of collected beans, lower orders (numbers) will be loaded first and the orders do not have to be consecutive (there can be gaps)</div> </th> </tr> <tr id="i81" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Outputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Outputable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/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> </th> </tr> <tr id="i82" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/OutputFormattable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">OutputFormattable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/Outputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Outputable</code></a><br/> NOTE: throwing <a href="org/sakaiproject/entitybroker/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> </th> </tr> <tr id="i83" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/OutputSerializable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">OutputSerializable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/Outputable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Outputable</code></a><br/></div> </th> </tr> <tr id="i84" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/PropertiesProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">PropertiesProvider</a></td> <th class="colLast" scope="row"> <div class="block">This simple defines the methods correctly which are shared between a set of interfaces, see <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/PropertyProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>PropertyProvideable</code></a> for more information</div> </th> </tr> <tr id="i85" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Propertyable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Propertyable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i86" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/PropertyProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">PropertyProvideable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/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="org/sakaiproject/entitybroker/entityprovider/capabilities/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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i87" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/QuerySearch.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">QuerySearch</a></td> <th class="colLast" scope="row"> <div class="block">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</div> </th> </tr> <tr id="i88" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Redirectable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Redirectable</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i89" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RedirectControllable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RedirectControllable</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i90" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RedirectDefinable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RedirectDefinable</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i91" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/ReferenceParseable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">ReferenceParseable</a></td> <th class="colLast" scope="row"> <div class="block">Indicates an entity provider has the capability of parsing its own reference string.</div> </th> </tr> <tr id="i92" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestAware.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestAware</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i93" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestGetter.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">RequestGetter</a></td> <th class="colLast" scope="row"> <div class="block">Allows for getting to the request and response objects for the current thread</div> </th> </tr> <tr id="i94" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestGetterWrite.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">RequestGetterWrite</a></td> <th class="colLast" scope="row"> <div class="block">Allows for getting to the request and response objects for the current thread</div> </th> </tr> <tr id="i95" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestHandler.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestHandler</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestInterceptor.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RequestInterceptor</code></a> which is triggered just before this would be called</div> </th> </tr> <tr id="i96" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestInterceptor.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestInterceptor</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i97" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestStorable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RequestStorable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/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="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestAware.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RequestAware</code></a> and <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RequestInterceptor.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RequestInterceptor</code></a></div> </th> </tr> <tr id="i98" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestStorage.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">RequestStorage</a></td> <th class="colLast" scope="row"> <div class="block">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<br/> 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<br/> Standard reserved keys have values that are always available:<br/> <b>_locale</b> : <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Locale</code></a> <b>_requestEntityReference</b> : String <b>_requestActive</b> : [true,false] <b>_requestOrigin</b> : ['REST','EXTERNAL','INTERNAL'] </div> </th> </tr> <tr id="i99" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestStorage.RequestOrigin.html" title="enum in org.sakaiproject.entitybroker.entityprovider.extension">RequestStorage.RequestOrigin</a></td> <th class="colLast" scope="row"> <div class="block">Indicates the origin of the current request</div> </th> </tr> <tr id="i100" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestStorage.ReservedKeys.html" title="enum in org.sakaiproject.entitybroker.entityprovider.extension">RequestStorage.ReservedKeys</a></td> <th class="colLast" scope="row"> <div class="block">Reserved keys with special data in them, see <a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestStorage.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension"><code>RequestStorage</code></a></div> </th> </tr> <tr id="i101" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/RequestStorageWrite.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">RequestStorageWrite</a></td> <th class="colLast" scope="row"> <div class="block">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<br/> 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<br/> Standard reserved keys have values that are always available:<br/> <b>_locale</b> : <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Locale</code></a> <b>_requestEntityReference</b> : String <b>_requestActive</b> : [true,false] <b>_requestOrigin</b> : ['REST','EXTERNAL','INTERNAL'] </div> </th> </tr> <tr id="i102" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Resolvable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Resolvable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i103" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RESTful.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">RESTful</a></td> <th class="colLast" scope="row"> <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> </th> </tr> <tr id="i104" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/search/Restriction.html" title="class in org.sakaiproject.entitybroker.entityprovider.search">Restriction</a></td> <th class="colLast" scope="row"> <div class="block">A simple bean which defines a restriction in a search, this is like saying: where userId = '123'; OR where userId like '%aaronz%';<br/> Example usage:<br/> <code>Restriction rteq = new Restriction("title", curTitle); // restrict search to title equals value of curTitle</code><br/> <code>Restriction rtne = new Restriction("title", curTitle, Restriction.NOT_EQUALS); // restrict search to title not equals value of curTitle</code><br/></div> </th> </tr> <tr id="i105" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/util/SakaiToolData.html" title="class in org.sakaiproject.entitybroker.util">SakaiToolData</a></td> <th class="colLast" scope="row"> <div class="block">This contains an abstraction of the information about a tool in Sakai</div> </th> </tr> <tr id="i106" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Sampleable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Sampleable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i107" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Saveable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Saveable</a></td> <th class="colLast" scope="row"> <div class="block">Convenience interface to indicates that an entity is can be saved, i.e. it is creatable and updateable</div> </th> </tr> <tr id="i108" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/search/Search.html" title="class in org.sakaiproject.entitybroker.entityprovider.search">Search</a></td> <th class="colLast" scope="row"> <div class="block">This is a simple class which allows the passing of a set of search parameters in a nice way<br/> Example usage:<br/> <code>Search s1 = new Search("title", curTitle); // search where title equals value of curTitle</code><br/> <code>Search s2 = new Search("title", curTitle, Restriction.NOT_EQUALS); // search where title not equals value of curTitle</code><br/> <code>Search s2 = new Search(<br/> new Restriction("title", curTitle),<br/> new Order("title")<br/> ); // search where title equals value of curTitle and order is by title ascending</code><br/> <br/> Most searches can be modeled this way fairly easily.</div> </th> </tr> <tr id="i109" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Searchable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Searchable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i110" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/SearchContent.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">SearchContent</a></td> <th class="colLast" scope="row"> <div class="block">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</div> </th> </tr> <tr id="i111" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/SearchProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">SearchProvider</a></td> <th class="colLast" scope="row"> <div class="block">Defines the methods related to searching for entities (shared between interfaces), implementing this allows for support for the core EB search functionality</div> </th> </tr> <tr id="i112" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/SearchResult.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">SearchResult</a></td> <th class="colLast" scope="row"> <div class="block">This is a single search result</div> </th> </tr> <tr id="i113" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/SearchResults.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">SearchResults</a></td> <th class="colLast" scope="row"> <div class="block">This represents the return data from a search</div> </th> </tr> <tr id="i114" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Statisticable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Statisticable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i115" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Taggable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Taggable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i116" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/TagProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">TagProvideable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/capabilities/Taggable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>Taggable</code></a>, inherits all methods from <a href="org/sakaiproject/entitybroker/entityprovider/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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i117" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/TagProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">TagProvider</a></td> <th class="colLast" scope="row"> <div class="block">Defines the methods related to tagging entities (shared between interfaces)</div> </th> </tr> <tr id="i118" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/TagSearchable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">TagSearchable</a></td> <th class="colLast" scope="row">Deprecated. <div class="deprecationComment">no longer functional, use <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/TagProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>TagProvideable</code></a></div> </th> </tr> <tr id="i119" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/TagSearchProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">TagSearchProvider</a></td> <th class="colLast" scope="row">Deprecated. <div class="deprecationComment">use <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/TagProvideable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>TagProvideable</code></a> and <a href="org/sakaiproject/entitybroker/entityprovider/extension/TagProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension"><code>TagProvider</code></a> instead</div> </th> </tr> <tr id="i120" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/TagSearchService.html" title="interface in org.sakaiproject.entitybroker.entityprovider.extension">TagSearchService</a></td> <th class="colLast" scope="row"> <div class="block">Defines the methods necessary for searching for entities by tags (shared interface)</div> </th> </tr> <tr id="i121" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/TemplateMap.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">TemplateMap</a></td> <th class="colLast" scope="row"> <div class="block">An object to hold the incoming and outgoing templates in pairs, used with <a href="org/sakaiproject/entitybroker/entityprovider/capabilities/RedirectDefinable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities"><code>RedirectDefinable</code></a></div> </th> </tr> <tr id="i122" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html" title="class in org.sakaiproject.entitybroker.util">TemplateParseUtil</a></td> <th class="colLast" scope="row"> <div class="block">Utility class to handle the URL template parsing (entity template parsing)</div> </th> </tr> <tr id="i123" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.PreProcessedTemplate.html" title="class in org.sakaiproject.entitybroker.util">TemplateParseUtil.PreProcessedTemplate</a></td> <th class="colLast" scope="row"> <div class="block">Contains the data for templates, each template must have a template key and the template itself</div> </th> </tr> <tr id="i124" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.ProcessedTemplate.html" title="class in org.sakaiproject.entitybroker.util">TemplateParseUtil.ProcessedTemplate</a></td> <th class="colLast" scope="row"> <div class="block">Contains the processed template with the values from the processed input string that was determined to be related to this template</div> </th> </tr> <tr id="i125" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.Template.html" title="class in org.sakaiproject.entitybroker.util">TemplateParseUtil.Template</a></td> <th class="colLast" scope="row"> <div class="block">Represents a parseable template (which is basically a key and the template string), the array which defines the set of template keys is <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#PARSE_TEMPLATE_KEYS"><code>TemplateParseUtil.PARSE_TEMPLATE_KEYS</code></a><br/> Rules for parse templates: 1) "{","}", and <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#SEPARATOR"><code>TemplateParseUtil.SEPARATOR</code></a> are special characters and must be used as indicated only 2) Must begin with a <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#SEPARATOR"><code>TemplateParseUtil.SEPARATOR</code></a>, must not end with a <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#SEPARATOR"><code>TemplateParseUtil.SEPARATOR</code></a> 3) must begin with "/{prefix}" (use the <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#SEPARATOR"><code>TemplateParseUtil.SEPARATOR</code></a> and <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#PREFIX"><code>TemplateParseUtil.PREFIX</code></a> constants) 3) each {var} can only be used once in a template 4) {var} can never touch each other (i.e /{var1}{var2}/{id} is invalid) 5) each {var} can only have the chars from <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#VALID_VAR_CHARS"><code>TemplateParseUtil.VALID_VAR_CHARS</code></a> 6) parse templates can only have the chars from <a href="org/sakaiproject/entitybroker/util/TemplateParseUtil.html#VALID_TEMPLATE_CHARS"><code>TemplateParseUtil.VALID_TEMPLATE_CHARS</code></a> 7) Empty braces ({}) cannot appear in the template</div> </th> </tr> <tr id="i126" class="altColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/capabilities/Updateable.html" title="interface in org.sakaiproject.entitybroker.entityprovider.capabilities">Updateable</a></td> <th class="colLast" scope="row"> <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="org/sakaiproject/entitybroker/entityprovider/EntityProvider.html" title="interface in org.sakaiproject.entitybroker.entityprovider"><code>EntityProvider</code></a> interface<br/></div> </th> </tr> <tr id="i127" class="rowColor"> <td class="colFirst"><a href="org/sakaiproject/entitybroker/entityprovider/extension/URLRedirect.html" title="class in org.sakaiproject.entitybroker.entityprovider.extension">URLRedirect</a></td> <th class="colLast" scope="row"> <div class="block">Storage for the redirects</div> </th> </tr> </table> </li> </ul> </div> </main> <footer role="contentinfo"> <nav role="navigation">  <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>Package</li> <li>Class</li> <li>Use</li> <li><a href="overview-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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <a id="skip.navbar.bottom">  </a></div>  </nav> <p class="legalCopy"><small>Copyright © 2023. All rights reserved.</small></p> </footer> </body> </html>