Index (Sakai Entity Broker API 22.3 API)

A B C D E F G H I J L M N O P Q R S T U V X _
All Classes All Packages

A

accepted() - Method in annotation type org.sakaiproject.entitybroker.entityprovider.annotations.EntityParameters: Indicates the valid parameters for a custom action or standard entity method (e.g.
AccessFormats - Interface in org.sakaiproject.entitybroker.access: 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 - Interface in org.sakaiproject.entitybroker.access: 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
action - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: The action key which will be used to trigger the action (e.g. promote), will be triggered by a URL like so: /user/aaronz/promote
action() - Method in annotation type org.sakaiproject.entitybroker.entityprovider.annotations.EntityCustomAction: (optional) The action key which will be used to trigger the action (e.g. promote)
By default the name of the method is used as the action key if this is not set, trigger this action using a URL like: /direct/{prefix}/{name}
ACTION_METHOD_SUFFIX - Static variable in interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable: Use this suffix or the EntityCustomAction annotation to indicate custom actions for your entities
ActionReturn - Class in org.sakaiproject.entitybroker.entityprovider.extension: 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(OutputStream) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Set the OutputStream to indicate it was used, uses default encoding UTF-8 and type of text/xml
ActionReturn(Object) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Special constructor which will ensure the data is output exactly as is without adding in the entity meta data
ActionReturn(Object, Map<String, String>) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Special constructor which will ensure the data is output exactly as is without adding in the entity meta data
ActionReturn(Object, Map<String, String>, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Special constructor which will ensure the data is output exactly as is without adding in the entity meta data
ActionReturn(String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Set a string of data to return, uses default encoding UTF-8 and type of text/xml
ActionReturn(String, String, OutputStream) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Create a return that is appropriate for sending binary data or a large chunk of text
ActionReturn(String, String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Create a return that is appropriate for sending back a string
ActionReturn(List<EntityData>, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Create a return that is appropriate for sending back a list of entities
ActionReturn(EntityData, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Create a return that is appropriate for sending back an entity
ActionReturn.Header - Enum in org.sakaiproject.entitybroker.entityprovider.extension
ActionsDefineable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
add(String, SearchContent) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.SearchProvider: Add some content to the search index for a given reference, this will replace existing content (not merge)
addCustomAction(String, CustomAction) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Add a custom action for a prefix
addEntityViewKeys(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Adds a view key which is known to be supported by this entity types access provider
addNestedPrefix(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Adds a nested prefix which is a child of this entity type
addOrder(Order) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
addRestriction(Restriction) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
addResult(SearchContent) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: Add results to the total results, this will not allow adding results beyond the totalItemsMatched (max) number
addResult(SearchResult) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: Add results to the total results, this will not allow adding results beyond the maxItemsToReturn (max) number
addTagsToEntity(String, String[]) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider: Add these tags to the an entity, will have no effect if the entity already has these tags
addURLRedirects(String, URLRedirect[]) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Add all URL redirects to the following prefix, maintains any existing ones
ADMIN_USER_ID - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService
ADMIN_USER_REF - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService
after(EntityView, HttpServletRequest, HttpServletResponse) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestInterceptor: Take actions after the request is handled for an entity view, this will be called just before each response is sent back to the requester, normally this would be used to add something to the response as it is getting ready to be sent back to the requester
ALL_KNOWN_FORMATS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: the array of all the known formats in this file
appendArray(T[], T) - Static method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Append an item to the end of an array and return the new array
arrayToString(Object[]) - Static method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Utility method to convert an array to a string
ascending - Variable in class org.sakaiproject.entitybroker.entityprovider.search.Order: if true then the return order is ascending, if false then return order is descending
ATOM - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: ATOM XML feed (application/atom+xml)
http://en.wikipedia.org/wiki/ATOM
INPUT: -not supported-
OUTPUT: -not supported-
ATOM_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
ATOM_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
AutoRegister - Interface in org.sakaiproject.entitybroker.collector: 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 - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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

B

BATCH - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: The reserved word used to trigger batch operations
BeanCollector<T> - Interface in org.sakaiproject.entitybroker.collector: 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 - Interface in org.sakaiproject.entitybroker.collector: 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)
before(EntityView, HttpServletRequest, HttpServletResponse) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestInterceptor: Take actions before the request is handled for an entity view, this will be called just before each request is sent to the correct request handler, this might be used to add information to the response before it goes on to be handled or to take some action as a result of information in the request or reference,
if you want to interrupt the handling of this request (stop it) then throw an EntityException and include the type of response you would like to return in the exception (this can be a success or failure response status)
BRACES - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
BROWSE_DESC_KEY - Static variable in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Browseable
BROWSE_TITLE_KEY - Static variable in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Browseable
Browseable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
browseEntities(String, Search, String, String, String, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Returns the list of entity information (and possibly entities) for a user to view while browsing an entity space, this is specially designed to support browsing and picking entities, not all entities support browsing
If the entity type indicated by the prefix does not support browsing then this will return an empty list
browseEntities(String, Search, String, String, EntityReference, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Fetches the browseable entities
browseEntities(Search, String, String, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.BrowseSearchable: Returns the list of entities which are being browsed based on the given parameters
See Browseable for the i18n keys
BrowseEntity - Class in org.sakaiproject.entitybroker.entityprovider.extension: This is an object to hold data about a browseable entity type
BrowseEntity(String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Minimal constructor
BrowseEntity(String, String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Constructor for types with no children or access provider
BrowseEntity(String, String, String, String[], String[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Constructor for complete types with most optional information, all optionals can be null
BrowseEntity.PrefixComparator - Class in org.sakaiproject.entitybroker.entityprovider.extension
BrowseEntity.TitleComparator - Class in org.sakaiproject.entitybroker.entityprovider.extension
BrowseNestable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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)

C

CACHE_CONTROL - org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn.Header
checkEntityURL(String) - Static method in class org.sakaiproject.entitybroker.EntityView: Check if an entityUrl is basically valid
checkPrefixId(String, String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Checks this prefix and id to see if they are valid format, throw exceptions if they aren't
checkReference(String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Check if a reference is basically valid
ClassLoaderReporter - Interface in org.sakaiproject.entitybroker.util: 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
clone() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
clone() - Method in class org.sakaiproject.entitybroker.EntityReference
clone() - Method in class org.sakaiproject.entitybroker.EntityView
cloneBean(T, int, String[]) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Deep clone a bean (object) and all the values in it into a brand new object of the same type, this will traverse the bean and will make new objects for all non-null values contained in the object, the level indicates the number of contained objects to traverse and clone, setting this to zero will only clone basic type values in the bean, setting this to one will clone basic fields, references, and collections in the bean, etc.
This is mostly useful for making a copy of a hibernate object so it will no longer be the persistent object with the hibernate proxies and lazy loading
CollectionResolvable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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.)
commonExtensions - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Contains a set of all the common extensions
compare(BrowseEntity, BrowseEntity) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity.PrefixComparator
compare(BrowseEntity, BrowseEntity) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity.TitleComparator
compare(EntityData, EntityData) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData.ReferenceComparator
compare(EntityData, EntityData) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData.TitleComparator
compareTo(URLRedirect) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
comparison - Variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction: the comparison to make between the property and the value, use the defined constants: e.g.
COMPENSATE_METHOD - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: This is the special indicator used to denote that POST should be translated to a PUT or DELETE in order to compensate for browser limitations, Example: /people/1?
conjunction - Variable in class org.sakaiproject.entitybroker.entityprovider.search.Search: if true then all restrictions are run using AND, if false then all restrictions are run using OR
contains(T[], T) - Static method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Checks to see if an array contains a value, will return the position of the value or -1 if not found
contextsField - Static variable in class org.sakaiproject.entitybroker.entityprovider.extension.QuerySearch
controllable - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: indicates that this is controllable or not, if this is controllable then all the other fields will be ignored and the redirects will be sent to the execute method
convert(Object, Class<T>) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Converts an object to any other object if possible
convertToEntityData(Object, EntityReference) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Convert a single object to an entity data object (also populates it), will preserve null (i.e. null in => null out)
convertToEntityData(List<?>, EntityReference) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Convert a list of objects to entity data objects (also populates them), will preserve null (i.e. null in => null out)
copy() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction
copy() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
copy() - Method in class org.sakaiproject.entitybroker.EntityReference
copy() - Method in class org.sakaiproject.entitybroker.EntityView
copy(CustomAction) - Static method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction
copy(URLRedirect) - Static method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
copy(Search, Search) - Static method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Make a copy of a search object
copy(EntityReference) - Static method in class org.sakaiproject.entitybroker.EntityReference: Creates a copy of an entity reference
copy(EntityView) - Static method in class org.sakaiproject.entitybroker.EntityView: Makes a copy of an EntityView which can be changed independently
copyBean(Object, Object, int, String[], boolean) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Deep copies one bean (object) into another, this is primarily for copying between identical types of objects but it can also handle copying between objects which are quite different, this does not just do a reference copy of the values but actually creates new objects in the current classloader and traverses through all properties of the object to make a complete deep copy
CoreEntityProvider - Interface in org.sakaiproject.entitybroker.entityprovider: 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 - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
createEntity(EntityReference, Object, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Createable: Create a new entity and return the unique local id of the entity, the object should contain the data needed to create the entity or this will fail
CRUDable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 - Class in org.sakaiproject.entitybroker.entityprovider.extension: 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
CustomAction(String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: Construct a custom action for entities
CustomAction(String, String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: Adds the methodName arg, use this version when using this with ActionsDefineable

D

DATE - org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn.Header
decodeData(String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Decode a string of a specified format into a java map of simple objects
Returned map can be fed into DeveloperHelperService.populate(Object, Map) if you want to convert it into a known object type
Types are likely to require conversion as guesses are made about the right formats, use of the DeveloperHelperService.convert(Object, Class) method is recommended
Current formats supported: JSON, XML
decodeData(String, String) - Method in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider: Decode a string of a specified format into a java map of simple objects
Returned map can be fed into #populate(Object, Map) if you want to convert it into a known object type
Types are likely to require conversion as guesses are made about the right formats, use of the #convert(Object, Class) method is recommended
defaultPreprocessedTemplates - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Stores the preloaded processed default templates
defaultTemplates - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Stores the preloaded default templates
defineActions() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsDefineable: Defines the custom actions which are allowed to be performed on your entities
defineHandledTemplatePatterns() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectControllable: Defines all the URL patterns that will be matched and passed through to #handleRedirects(String, String[], Map) NOTE: /{prefix}/ must be included as the start of the template
defineURLMappings() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable: Defines the set of simple URL rewrites for this prefix
Simple rewrites require no processing logic to handle the redirect and the redirect is always processed before anything validity checks happen
Some examples:
/myprefix/item/{id} => /my-item/{id}
/myprefix/{year}/{month}/{day} => /myprefix/?
deflt() - Method in annotation type org.sakaiproject.entitybroker.entityprovider.annotations.EntityHttpParam: Defines the default value for this parameter (the value to use when no value is found in the request), by default the method parameter will be set to null if this is not set
DELETE - org.sakaiproject.entitybroker.EntityView.Method
Deleteable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
deleteEntity(EntityReference, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable: Deletes the entity identified by this entity reference, if the entity cannot be found then nothing happens
DepthLimitable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: This entity type can specify its own recursion depth limit.
DESCRIBE - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: The reserved word used to trigger entity descriptions
Describeable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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: