Index (Sakai Entity Broker API 21.5 API)

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

A

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_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(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(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(EntityData, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Create a return that is appropriate for sending back an entity
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.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 or use the EntityCustomAction suffix to define the custom actions
You can describe the actions using the Describeable key: .action.
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.
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.
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

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.
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(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)
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)
copy() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction
copy(CustomAction) - Static method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction
copy() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
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() - Method in class org.sakaiproject.entitybroker.EntityReference
copy(EntityReference) - Static method in class org.sakaiproject.entitybroker.EntityReference: Creates a copy of an entity reference
copy() - Method in class org.sakaiproject.entitybroker.EntityView
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.
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

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/?
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.
DescribeDefineable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This is the configuration interface
This is one of the capability extensions for the EntityProvider interface
DescribePropertiesable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: This allows an entity to define the Properties files/classes to be used for looking up descriptions of the entity (Describeable)
This is the configuration interface
This is one of the capability extensions for the EntityProvider interface
DeveloperHelperService - Interface in org.sakaiproject.entitybroker: Includes methods which are likely to be helpful to developers who are implementing entity providers in Sakai and working with references
DIRECT - Static variable in class org.sakaiproject.entitybroker.EntityView
DIRECT_PREFIX - Static variable in class org.sakaiproject.entitybroker.EntityView
DIRECT_PREFIX - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
DIRECT_PREFIX_SLASH - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
DOT_EXTENSION - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: The extension with a period in front marker (Example value: ".xml")

E

encodeData(Object, String, String, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Encode data into a given format, can handle any java object, note that unsupported formats and invalid data will result in an exception
Current formats supported: JSON, XML, HTML
encodeData(Object, String, String, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider: Encode data into a given format, can handle any java object, note that unsupported formats and invalid data will result in an exception
encoding - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: The encoding to use for the output when it is returned
entitiesList - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: A List of entities to return, leave as null if not used
EntityBroker - Interface in org.sakaiproject.entitybroker: This service interface defines the capabilities of the entity broker system
It allows Sakai system methods, developers, etc. to access Sakai entity information (new and old)
EntityBrokerException - Exception in org.sakaiproject.entitybroker.exception: The base class for all exceptions out of the entity broker system
EntityBrokerException(String, String) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityBrokerException
EntityBrokerException(String, String, Throwable) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityBrokerException
EntityBrokerManager - Interface in org.sakaiproject.entitybroker: 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
EntityContent - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityCustomAction - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: This annotation indicates that this method is a custom action from ActionsExecutable, 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
By default the name of the method is used as the action key and this will work for read requests (viewKey is set to EntityView.VIEW_SHOW), you can add in action and viewKey annotation params to change those settings
You can describe this action using the key: .action.
entityData - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: An entity object to return, leave as null if not used
EntityData - Class in org.sakaiproject.entitybroker.entityprovider.extension: 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
EntityData(String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Minimal constructor - used for most basic cases
Use the setters to add in properties or the entity if desired
EntityData(String, String, Object) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Basic constructor
Use this to construct a search result using the typical minimal amount of information, Use the setters to add in properties or the entity if desired
EntityData(String, String, Object, Map<String, Object>) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Full constructor
Use this if you want to return the entity itself along with the key meta data and properties
EntityData(EntityReference, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Minimal constructor - used for most basic cases
Use the setters to add in properties or the entity data if desired
EntityData(EntityReference, String, Object) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Basic constructor
Use this to construct a search result using the typical minimal amount of information, Use the setters to add in properties or the entity data if desired
EntityData(EntityReference, String, Object, Map<String, Object>) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Full constructor
Use this if you want to return the entity itself along with the key meta data and properties
EntityData(Object) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Using this as a data wrapper only
EntityData(Object, Map<String, Object>) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: Using this as a data wrapper only
EntityData.ReferenceComparator - Class in org.sakaiproject.entitybroker.entityprovider.extension
EntityData.TitleComparator - Class in org.sakaiproject.entitybroker.entityprovider.extension
EntityDateCreated - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: Marks a getter method or field as the date created time code (unix time code) for an entity, this can be a Date, Long, long, or String (will attempt to convert this to a long)
the convention is to try to convert the return from the "getDateCreated" method or the value in the "dateCreated" field
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityEncodingException - Exception in org.sakaiproject.entitybroker.exception: Throw to indicate that there was a failure during encoding/decoding an entity or related data
EntityEncodingException(String, String) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityEncodingException
EntityEncodingException(String, String, Throwable) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityEncodingException
EntityException - Exception in org.sakaiproject.entitybroker.exception: 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)
Client Error
400 Bad Request The request could not be understood by the server due to malformed syntax.
EntityException(String, String) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityException: Create an exception to indicate that this entity could not found, this will trigger an HTTP NOT FOUND error if not caught before reaching the direct servlet, defaults to not found response
EntityException(String, String, int) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityException: Create an exception to indicate that this entity could not found, this will trigger an HTTP NOT FOUND error if not caught before reaching the direct servlet
entityExists(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Convenience method from EntityBroker
Check if an entity exists by the globally unique reference string, (the global reference string will consist of the entity prefix and any local ID).
entityExists(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Check if an entity exists by the globally unique reference string, (the global reference string will consist of the entity prefix and any local ID).
entityExists(EntityReference) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Determines if an entity exists based on the reference
entityExists(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider: Check if a specific entity managed by this provider exists.
EntityFieldRequired - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
EntityHttpParam - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
Binds the value(s) of a HTTP query parameter to a resource method parameter.
EntityId - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityLastModified - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: Marks a getter method or field as the last modified time code (unix time code) for an entity, this can be a Date, Long, long, or String (will attempt to convert this to a long)
the convention is to try to convert the return from the "getLastModified" method or the value in the "lastModified" field
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityModifiedBy - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: Marks a getter method or field as the user ref of the last user to modify an entity
the convention is to run toString on the return from the "getModifiedBy" method or the value in the "modifiedBy" field
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityNotFoundException - Exception in org.sakaiproject.entitybroker.exception: Throw to indicate that there was a failure finding an entity or collection of entities
EntityNotFoundException(String, String) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityNotFoundException
EntityNotFoundException(String, String, Throwable) - Constructor for exception org.sakaiproject.entitybroker.exception.EntityNotFoundException
EntityOwner - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityParameters - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
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
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
EntityPropertiesService - Interface in org.sakaiproject.entitybroker.providers: This provides the entity system with a way to access properties (and then exposes this to others via the developer helper service)
EntityProvider - Interface in org.sakaiproject.entitybroker.entityprovider: Beans may implement this interface directly to provide "extension" capabilities to an existing CoreEntityProvider.
EntityProviderListener<T extends EntityProvider> - Interface in org.sakaiproject.entitybroker.entityprovider.extension: This allows a developer to be notified whenever a provider is registered, it will also ensure that it calls the listener method for any providers that are already registered when it is first registered if desired
Usage:
Just implement this class and use EntityProviderManager#registerNotifier(EntityProviderNotifier) to register it with the system.
EntityProviderManager - Interface in org.sakaiproject.entitybroker.entityprovider: Handles all internal work of managing and working with the entity providers

Registration of entity brokers happens via spring, see the EntityProvider interface for details
EntityProviderMethodStore - Interface in org.sakaiproject.entitybroker.entityprovider: 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
EntityReference - Class in org.sakaiproject.entitybroker: The class of all Entity references handled by the EntityBroker system.
EntityReference() - Constructor for class org.sakaiproject.entitybroker.EntityReference
EntityReference(String) - Constructor for class org.sakaiproject.entitybroker.EntityReference: Constructor which takes an entity reference, this is the most common way to construct an entity reference object
EntityReference(String, String) - Constructor for class org.sakaiproject.entitybroker.EntityReference: Convenience constructor for when you know the prefix and/or id
entityReference - Variable in exception org.sakaiproject.entitybroker.exception.EntityBrokerException: The unique reference for the entity or entity space related to this failure
EntityRequestHandler - Interface in org.sakaiproject.entitybroker.providers: Handles the URL/request processing for an entity in a central location
EntityResponse - Class in org.sakaiproject.entitybroker.util: This is here to contain the information we get back from an entity (http) request fired by the EntityBroker.fireEntityRequest(String, String, String, Map, Object) method
This object and the data in it should be considered immutable
EntityResponse(int, String, String, Map<String, String[]>) - Constructor for class org.sakaiproject.entitybroker.util.EntityResponse
EntityRESTProvider - Interface in org.sakaiproject.entitybroker.providers: Handles anything REST based that is not part of the core EB registration piece
EntitySummary - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityTitle - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
NOTE: This annotation should only be used once in a class, the getter method must take no arguments and return an object
EntityURLRedirect - Annotation Type in org.sakaiproject.entitybroker.entityprovider.annotations: 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
Define the URL pattern to match AFTER the /prefix using {name} to indicate variables
Example: /{thing}/site/{siteId} will match the following URL:
/myprefix/123/site/456, the variables will be {prefix => myprefix, thing => 123, siteId => 456}
NOTE: all incoming URL templates must start with "/{prefix}" (TemplateParseUtil.TEMPLATE_PREFIX)

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
The methods that this annotates should return a String or void
They can have the following parameter types:
(type => data which will be given to the method)
String : incoming URL
EntityView.Method : the submission method (GET,POST,etc)
String[] : incoming URL segments, Example: /myprefix/123/apple => {'prefix','123','apple'}
Map (String => String) : a map of the variable values in the {}, Example: pattern: /{prefix}/{thing}/apple, url: /myprefix/123/apple, would yield: {'thing' => '123','prefix' => 'mypreifx'}
Don't forget to handle the extensions as they will not automatically pass through, use the TemplateParseUtil.DOT_EXTENSION and TemplateParseUtil.EXTENSION values from the variable map which will contain the extension that was passed in

Return should be one of the following:
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
2) "" (empty string) to not redirect and return an empty success response
3) null to not redirect and allow standard processing of the URL to continue
For failures: if there is a failure you should throw an IllegalStateException to indicate failure
This is the convention part of the Redirectable capability
EntityView - Class in org.sakaiproject.entitybroker: Defines an entity view (a specific way to looking at entity data, e.g.
EntityView() - Constructor for class org.sakaiproject.entitybroker.EntityView
EntityView(String) - Constructor for class org.sakaiproject.entitybroker.EntityView: Constructor which takes an entity URL path, (should not include anything but the path, for example: http://server/webapp/myprefix/edit/3/stuff.xml?
EntityView(String, Map<String, String>, String) - Constructor for class org.sakaiproject.entitybroker.EntityView: Turn this viewKey and map of segments (key -> value pairs) into an entity view object
EntityView(EntityReference, String, String) - Constructor for class org.sakaiproject.entitybroker.EntityView: Construct an entity view based on a reference, view, and format extension
EntityView.Method - Enum in org.sakaiproject.entitybroker: Represents HTTP methods (GET, POST, etc.)
EntityViewAccessProvider - Interface in org.sakaiproject.entitybroker.access: Represents a bean which is capable of handling access for an EntityView, this replaces the HttpServletAccessProvider as all entity URLs are now being parsed so more information can be provided through the EntityView

This interface would be typically implemented from a tool (webapp) context, and registered with the EntityViewAccessProviderManager in a context loader listener

If the implementation throws a SecurityException 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
If you want to control the requests which make it through to this by format type you can optionally implement AccessFormats
EntityViewAccessProviderManager - Interface in org.sakaiproject.entitybroker.access: Manages all the access providers for the entity views in the system
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
EntityViewUrlCustomizable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Indicates that the entity URLs for the types of entities handled by this provider are customized by the set of entity templates returned
These will be used
equals(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
equals(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
equals(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
equals(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order
EQUALS - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
equals(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
equals(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
equals(Object) - Method in class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template
EventReceiver - Interface in org.sakaiproject.entitybroker.event: 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
executeActions(EntityView, String, Map<String, Object>, OutputStream) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutionControllable: This allows the developer to define how to execute custom actions on entities, this method will be called every time a custom action execution is requested, the incoming data provides the context for the action to be executed
NOTE: The return data can be complex so please read carefully, entity data is returned as the default for the request if no format is specified
executeCustomAction(String, String, Map<String, Object>, OutputStream) - Method in interface org.sakaiproject.entitybroker.EntityBroker: This will execute a custom action for an entity or space/collection of entities
This is meant for specialized usage as custom actions are typically meant to be executed by REST calls only
Exportable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This is one of the capability extensions for the EntityProvider interface
exportData(String, Search, OutputStream, boolean, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Exportable: Request an export stream of data from an entity provider for all data related to a specific entity (this will probably not be an entity in this provider), search, and parameters
This is primarily to support the use case archiving and exporting data from a system which related to a user or a site/group
EXTENSION - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: The entity extension (format) marker (Example value: "xml")
extension - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.ProcessedTemplate: The extension found while processing the input string, null if none could be found
ExternalIntegrationProvider - Interface in org.sakaiproject.entitybroker.providers

F

FAKE_ID - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: The id used in generated URLs
fetchEntities(String, Search, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Allows these entities to be fetched based on search parameters, this should never return null and if there are no entities then the list should be empty
Note: The entity class types in the list need to be able to be resolved from the ClassLoader of the EntityBrokerManager (currently this means deployed into shared)

These do not have to be model objects and may simply be something created (e.g.
fetchEntities(EntityReference, Search, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Get a list of entities from CollectionResolvable first if available or BrowseSearchable if not, returns the entities as actual entities (converts from EntityData if that was used), correctly handles references to single entities as well
fetchEntity(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Convenience method from EntityBroker
Fetches a concrete object representing this entity reference; either one from the Resolvable capability if implemented by the responsible EntityProvider, or else from the underlying legacy Sakai entity system
fetchEntity(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Fetches a concrete object representing this entity reference; either one from the Resolvable capability if implemented by the responsible EntityProvider, or else from the underlying legacy Sakai entity system
Note that this may be a String or Map and does not have to be a POJO, the type of object should be determined out of band
This will return null if the entity exists but is not Resolvable or available in the legacy entity system
fetchEntity(EntityReference) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Get an entity object of some kind for this reference if it has an id, will simply return null if no id is available in this reference
fetchEntity(String) - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Fetches a concrete object representing this entity reference from an external system
Note that this object may be a String or Map and does not have to be a POJO, the type of object should be determined out of band
This should return null if the entity exists but has no available object
findCustomActions(EntityProvider, boolean) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Get all the custom actions that can be found
findEntitesByTags(String[], String[], boolean, Search, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Search for all entities which have the given tags, can limit the return using the search object
findEntitesByTags(String[], boolean, Search) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.TagProvideable: Search for all entities which have the given tags, can limit the return using the search object
NOTE: Don't forget to check the RequestStorable request params for extra information about the current user and location and other possible params when implementing this
findEntitesByTags(String[], String[], boolean, Search) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.TagSearchService: Search for all entities with a set of tags, prefixes, and a search
findEntityRefs(String[], String[], String[], boolean) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider: Allows searching for entities by meta property values, at least one of the params (prefix, name, searchValue) must be set in order to do a search, (searches which return all references to all entities with properties are not allowed)
WARNING: this search is very fast but will not actually limit by properties that are placed on the entity itself or return the entity itself and is not a substitute for an API which allows searches of your entities (e.g List getYourStuff(Search search); )
findEntityRefsByTags(String[]) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.TagSearchProvider: Deprecated.
use TagProvideable and TagProvider instead
findExtension(String) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Find the extension from a string and return the string without the extension and the extension, an extension is a period (".") followed by any number of non-periods, the original input is returned as the 0th item in the array
returned array contains 3 strings:
0 = the original input string
1 = the string without the extension or the original if it has none
2 = the extension OR null if there is no extension
findId(String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Get the local entity id based on a full entity reference
findPrefix(String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Get the entity prefix based on an entity reference
findService(Class<T>) - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Allows services in the external system to be located (this is used to find external providers for overriding the default internal services)
findURLRedirectMethods(EntityProvider) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Looks for redirect methods in the given entity provider
fireEntityRequest(String, String, String, Map<String, String>, Object) - Method in interface org.sakaiproject.entitybroker.EntityBroker
fireEvent(String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Convenience method from EntityBroker
Fire an event to Sakai with the specified name, targetted at the supplied reference, which should be a reference to an existing entity managed by this broker
NOTE: This will allow events to be fired for references without a broker or invalid references
fireEvent(String, String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Fire an event to Sakai with the specified name, targeted at the supplied reference, which should be a reference to an existing entity managed by this broker
NOTE: This will allow events to be fired for references without a broker or invalid references
fireEvent(String, String) - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Fires events from EB using an external event system
You can assume the eventName is not null and the reference has been validated and normalized
NOTE: if you have no way to handle external events then throw UnsupportedOperationException
FORM - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: Special output format which indicates this entity will use internally generated forms for input data, the output simply produces very simple html forms, this is handled internally
INPUT: none
OUTPUT: XHTML text (forms for submitting data)
FORM_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
FORM_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
format - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Indicates the format (from Formats) to return the entity data in if there is any, if using an outputstream, use encoding and mimetype
format - Variable in exception org.sakaiproject.entitybroker.exception.FormatUnsupportedException: The format which could not be handled
formatAndOutputEntity(String, String, List<?>, OutputStream, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Format and output an entity or collection included or referred to by this entity ref object into output according to the format string provided, Should take into account the reference when determining what the entities are and how to encode them
formatAndOutputEntity(EntityReference, String, List<EntityData>, OutputStream, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider: Format and output an entity or collection included or referred to by this entity ref object into output according to the format string provided, Should take into account the reference when determining what the entities are and how to encode them (This is basically a copy of the code in EntityHandlerImpl with stuff removed)
formatOutput(EntityReference, String, List<EntityData>, Map<String, Object>, OutputStream) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.OutputFormattable: Formats the entity or collection included or referred to by this entity ref object into output according to the format string provided, Should take into account the reference when determining what the entities are and how to encode them
NOTE: be careful to correctly handle the list of entities which are meant to be encoded, note that the EntityData objects include meta data and the data they contain can be of any object type (though all data will come from your provider so the types should not be surprising)
Formats - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Defines a list of possible format types (extensions) which can be handled and indicates which are handled internally
FormatUnsupportedException - Exception in org.sakaiproject.entitybroker.exception: 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
FormatUnsupportedException(String, String, String) - Constructor for exception org.sakaiproject.entitybroker.exception.FormatUnsupportedException
FormatUnsupportedException(String, Throwable, String, String) - Constructor for exception org.sakaiproject.entitybroker.exception.FormatUnsupportedException

G

getAllRefs(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Searchable: Retrieve all entities for a given context
getAnazlyzedTemplates() - Method in class org.sakaiproject.entitybroker.EntityView
getArrayValue() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
getAssociatedToolId() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Statisticable: Return the associated common tool.id for this tool
getBaseName() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.DescribePropertiesable: Defines the Properties file/class baseName which is used to find descriptions of an entity as per the keys defined in Describeable
The baseName will be the file without the .properties or the locale codes
Examples:
myentity - would match: myentity.properties, myentity_en.properties, myentity_en_GB.properties, etc.
getBooleanValue() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
getBrowseableEntities(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: For authors of entity browsing systems, this provides a list of all the meta data related to the entities in the system which are Browseable, this provides the root entities when there is no parent prefix provided
getBrowseableEntities(String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Get the meta data about browseable entities
getCapabilityFilter() - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.EntityProviderListener
getChildrenEntities(EntityReference, Search, String, String, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.BrowseNestable: Returns the list of entities being browsed which are nested under a parent entity with a given reference
Example: Parent entity is /blog/123, there are 3 entries in this blog, the search limits the return to 2 entities This method should return the first 2 blog entries in the blog with reference /blog/123
getCollectedType() - Method in interface org.sakaiproject.entitybroker.collector.BeanCollector: This allows the developer to set the type of the beans which they want collected
getCollectedTypes() - Method in interface org.sakaiproject.entitybroker.collector.BeanMapCollector: This allows the developer to set the types of the beans which they want collected
getComparison() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction: the comparison to make between the property and the value, use the defined constants: e.g.
getConfigurationSetting(String, T) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Retrieves settings from the configuration service (sakai.properties)
getConfigurationSetting(String, T) - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Retrieves settings from the configuration service (sakai.properties)
getCurrentLocale() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getCurrentLocationId() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getCurrentLocationReference() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getCurrentToolReference() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getCurrentUserId() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Get the user entity id (e.g. not eid or username) of the current user if there is one, this is not equivalent to the current user reference
recommend you use DeveloperHelperService.getCurrentUserReference() instead
getCurrentUserReference() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Get the user entity reference (e.g.
getCustomAction(String, String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Get the CustomAction for a prefix and action if it exists
getCustomActions(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Gets the list of all custom actions for a prefix
getData(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Searchable: Will be called to retrieve the data for this item when the system thinks the data related to an entity may have changed
getData() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: (OPTIONAL - may be null) This is the entity data object itself (if there is one), this is included at the discretion of the entity provider author, if this is null then the entity data is not available or would be prohibitively large (i.e. typically left out for efficiency)
getDefaultTemplate(String) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Get a default template for a specific template key
getDescription(Locale, String) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.DescribeDefineable: Allows for complete control over the descriptions of entities
This will always be called first if it is defined, returning a null will default to attempting to get the value from the properties (if any are defined), returning an empty string will cause nothing to be shown for the description
getDescription() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
getDescription() - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
getDisplayTitle() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: A string which is suitable for display and provides a short summary of the entity, typically 100 chars or less, this may be the name or title of the data represented by an entity
getEncoding() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getEndIndex() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getEndNum() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getEntities(String, Search, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Gets entity data (and possibly entities) for a specific entity prefix, entity data contains the reference, URL, display title and optionally the concrete entity and properties
If the entity type indicated by the prefix does not support collections then this will return an empty list
getEntities(EntityReference, Search) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable: Allows these entities to be fetched based on search parameters, this should never return null and if there are no entities then the list should be empty
Note: The entity class types in the list need to be able to be resolved from the ClassLoader of the EntityBrokerManager (currently this means deployed into shared)

These do not have to be model objects and may simply be something created (e.g.
getEntitiesData(EntityReference, Search, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Get a list of entities from CollectionResolvable first if available or BrowseSearchable if not, returns the entities wrapped in EntityData, correctly handles references to single entities as well
getEntitiesList() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getEntity(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Gets the data related to an entity as long as it exists, always includes at least the entity reference information and the URL, may also include a concrete entity object and entity properties
getEntity(EntityReference) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable: Allows this entity to be fetched based on the ref (prefix and local id), also used to determine the class type of these entities by requesting an entity without specifying an id (id = null)
WARNING: this method should not return null, throw the appropriate exception if the entity data cannot be found Note: The entity class type needs to be able to be resolved from the ClassLoader of the EntityBrokerManager (currently this means deployed into shared)

The entity object does not have to be a model object itself and may simply be something created (Map, String, EntityData, etc.) to give to anyone calling this method.
getEntityAccessViews() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Get the list of entity access views (e.g.
getEntityData(EntityReference) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Get the entity data for a reference if possible
getEntityData() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getEntityId() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
getEntityPrefix() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider: Controls the globally unique prefix for the entities handled by this provider
For example: Announcements might use "annc", Evaluation might use "eval" (if this is not actually unique then an exception will be thrown when Sakai attempts to register this broker)
(the global reference string will consist of the entity prefix and the local id)
getEntityProperties() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Allows access to the current EntityPropertiesService service
getEntityProperties() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: A set of properties to return along with the entity information, this may be presented and used for filtering, this will be empty if it is not used
getEntityPropertiesService() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the current EntityPropertiesService
getEntityProviderManager() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the current EntityProviderManager service
getEntityProviderMethodStore() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the current EntityProviderMethodStore service
getEntityProviderMethodStore() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Allows access to the current EntityProviderMethodStore service
getEntityRef() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: The entity reference object which makes it easy to get to the prefix or id of this entity if needed
getEntityReference() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: The entity reference - a globally unique reference to an entity, consists of the entity prefix and optional segments (normally the id at least)
getEntityReference() - Method in class org.sakaiproject.entitybroker.EntityView
getEntityReferencesForUserAndPermission(String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Find the entity references which a user has a specific permission in, this is most commonly used to get the list of sites which a user has a permission in but it will work for any entity type which uses Sakai permissions
getEntityRESTProvider() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the registered REST provider if there is one
getEntityURL(String, String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Convenience method from EntityBroker
Get the full absolute URL to the entity view defined by these params, this will fail-safe to a direct URL to an entity space URL if that is all that is available, this will use the default entity URL template associated with the viewKey and include an optional extension if specified (these will be inferred if they are missing)
getEntityURL(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Get the full absolute URL to the entity defined by this entity reference, this will fail-safe to a direct URL to an entity space URL if that is all that is available
getEntityURL(String, String, String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Get the full absolute URL to the entity view defined by these params, this will fail-safe to a direct URL to an entity space URL if that is all that is available, this will use the default entity URL template associated with the viewKey and include an optional extension if specified (these will be inferred if they are missing)
getEntityURL(String, String, String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Creates the full URL to an entity using the sakai ServerConfigurationService, (e.g. http://server:8080/direct/entity/123/)

Note: the webapp name (relative URL path) of the direct servlet, of "/direct" is hardcoded into this method, and the org.sakaiproject.entitybroker.util.servlet.DirectServlet must be deployed there on this server.
getEntityURL() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: The entityURL to the entity represented by this reference, should be an absolute entityURL (server name optional)
getEntityURL() - Method in class org.sakaiproject.entitybroker.EntityView
getEntityURL(String, String) - Method in class org.sakaiproject.entitybroker.EntityView: Get an entityUrl by merging a specific template with the data in this EB object
getEntityView(String, String, String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Get the EntityView object which represents a specific view of an entity or entity collection, this is similar to EntityBroker.getEntityURL(String, String, String) but allows the developer to deal with the EntityView object if desired
getEntityViewAccessProviderManager() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the current EntityViewAccessProviderManager service
getEventKeys() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Statisticable: Return an array of all the event keys which should be tracked for statistics
getEventNamePrefixes() - Method in interface org.sakaiproject.entitybroker.event.EventReceiver: This defines the events that you want to know about by event name, receiveEvent(String, String) will be called whenever an event occurs which has a name which begins with any of the strings this method returns, simply return empty array if you do not want to match events this way

Note: Can be used with getResourcePrefix()
getEventNames(Locale) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Statisticable: OPTIONAL: return null if you do not want to implement this
Return the event key => event name map for a given Locale, allows the author to create human readable i18n names for their event keys
getExtension() - Method in class org.sakaiproject.entitybroker.EntityView: The extension for this view which defines the type of data that will be returned for this view, examples: html, xml, json NOTE: you should assume html return format when this is null
getExternalIntegrationProvider() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to any registered ExternalIntegrationProvider
getFormat() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getFormat() - Method in class org.sakaiproject.entitybroker.EntityView
getHandledAccessFormats() - Method in interface org.sakaiproject.entitybroker.access.AccessFormats: Defines the access format types (extensions) handled by this access provider
The default if this interface is not implemented is to pass through all requests to the access provider that is defined
getHandledEntityViews() - Method in interface org.sakaiproject.entitybroker.access.AccessViews: Defines the entity views handled by this access provider
The default if this interface is not implemented is to pass through all requests to the access provider that is defined
getHandledInputFormats() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable: Defines the input format types (extensions) handled by this provider
NOTE: In the case of an entity view the extension which goes on the end of an entity URL (after a ".") indicates the input type
WARNING: not including Formats.HTML in the return will stop all redirects to the access providers and therefore will cause HTML requests for entities to go nowhere
getHandledOutputFormats() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable: Defines the output format types (extensions) handled by this provider
NOTE: In the case of an entity view the extension which goes on the end of an entity URL (after a ".") indicates the return type
WARNING: This combines with the access interface when http requests are being processed, all requests will pass through to the EntityViewAccessProvider if they are not handled
getHeaders() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getHighlights() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResult
getId() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getId() - Method in class org.sakaiproject.entitybroker.EntityReference: A local entity id, represents an entity uniquely in a tool/webapp, could match with the actual id of a model data object, this will be null if this reference refers to an entity space only
getID(String) - Static method in class org.sakaiproject.entitybroker.IdEntityReference: Deprecated.
do not use this method anymore, use the constructors for EntityReference
getIdFromRef(String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Will convert a reference into an id (even if it is not a reference)
getIdFromRefByKey(String, String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Get the id value out of a reference by the key that preceeds it
getIncomingTemplate() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap
getItemsPerPage() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getLimit() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
getLocale() - Method in interface org.sakaiproject.entitybroker.providers.EntityPropertiesService
getLocationIdFromRef(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getLocationReference() - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
getLocationReferenceURL(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getMaxDepth() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.DepthLimitable: Retrieve the recursion depth limit for this provider.
getMaxItemsToReturn() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getMaxJSONLevel() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Returns the maximum depth of object graph allowed during transcoding to JSON
getMaxJSONLevel() - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Gets the entitybroker.maxJSONLevel config string from sakai.properties via ServerConfigurationService.
getMessage(String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Gets messages from the entity message bundles (the entities which implement Describeable or a sub interface),
getMethod() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: INTERNAL USE ONLY
getMethod() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: INTERNAL USE ONLY
getMethod() - Method in class org.sakaiproject.entitybroker.EntityView
getMimeType() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getNestedPrefixes() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity: Gets all the nested children prefixes for this entity type (if there are any)
getOrder() - Method in interface org.sakaiproject.entitybroker.collector.OrderedBean: Sets the order to load the bean which implements this method compared to other beans of the same type, lower orders (numbers) will be loaded first (i.e. order 1 will appear before order 3 in the list) and the orders do not have to be consecutive (there can be gaps), 2 beans with the same order or beans with no order set will be ordered randomly
getOrders() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Orders define the order of the returned results of a search, You can add as many orders as you like and they will be applied in the array order
getOriginalEntityUrl() - Method in class org.sakaiproject.entitybroker.EntityView: Special use only, normally you should use EntityView.toString() or EntityView.getEntityURL(String, String)
getOriginalQuery() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getOriginalReference() - Method in class org.sakaiproject.entitybroker.EntityReference: This is a special method and should not normally be used, use EntityReference.toString() or EntityReference.getReference()
getOutgoingTemplate() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap
getOutput() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getOutputString() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getPagesNum() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getParentprefix() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.BrowseNestable: Defines the parent entity type for this one
getParentPrefix() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
getParsedExemplar() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.ReferenceParseable: Returns an example instance of the EntityReference class that this EntityProvider uses as its reference type.
getParseTemplate(String) - Method in class org.sakaiproject.entitybroker.EntityView
getParseTemplates() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.EntityViewUrlCustomizable: Defines a set of parseable templates to use with entity url processing for this template (which is basically a key and the template string), the array which defines the set of template keys is TemplateParseUtil.PARSE_TEMPLATE_KEYS
Rules for parse templates:
1) "{","}", and #SEPARATOR are special characters and must be used as indicated only
2) Must begin with a #SEPARATOR, must not end with a #SEPARATOR
3) must begin with "/{prefix}" (use the #SEPARATOR and #PREFIX 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 TemplateParseUtil.VALID_VAR_CHARS
6) parse templates can only have the chars from TemplateParseUtil.VALID_TEMPLATE_CHARS
7) Empty braces ({}) cannot appear in the template

You do not have to supply a template for all the keys in TemplateParseUtil.PARSE_TEMPLATE_KEYS, any that you do not include will simply use the default templates, be careful though, since they will be parsed in order you have to be careful about the order you place your templates in the list, check the default order as an example
getParseTemplates() - Method in class org.sakaiproject.entitybroker.EntityView
getPathSegment(String) - Method in class org.sakaiproject.entitybroker.EntityView: Gets the parsed values of path segment variables
getPathSegment(int) - Method in class org.sakaiproject.entitybroker.EntityView: Get a segment value by position from the encoded URL for this view
Position 0 is always the prefix
Example: /user/aaronz/promote/stuff.xml
position 0: 'user'
position 1: 'aaronz'
position 2: 'promote'
position 3: 'stuff'
position 4: null
getPathSegments() - Method in class org.sakaiproject.entitybroker.EntityView: Get all the path segments for the encoded URL for this view
Example: /user/aaronz/promote/stuff.xml
segments = {"user","aaronz","promote","stuff"}
getPerPageNum() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getPlacementId() - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
getPortalURL() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getPrefix() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
getPrefix() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getPrefix() - Method in class org.sakaiproject.entitybroker.EntityReference
getPrefix(String) - Static method in class org.sakaiproject.entitybroker.EntityReference: Get the entity prefix based on an entity reference string, WARNING: this is meant for internal use, use EntityReference(String) and the methods in EntityBroker to parse references
getPrefixCapabilities(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Get all the capabilities for a given entity prefix, WARNING: This is very inefficient so you should normally use EntityProviderManager.getProviderByPrefixAndCapability(String, Class) when trying to determine if a provider implements a specific capability
getPrefixesByCapability(Class<T>) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Gets the prefixes which support a specific capability
getPrefixFilter() - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.EntityProviderListener
getProperties(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider: Retrieve all meta properties for this entity as a map of name->value
getProperties() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getProperty(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent: Get any property from this search content
getProperty() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order: the name of the field (property) in the persisted object
getProperty() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction: the name of the field (property) in the search
getProperty(String, String) - Method in interface org.sakaiproject.entitybroker.providers.EntityPropertiesService: Get a property for an entity if one is available, uses the default Locale
getProperty(String, String, Locale) - Method in interface org.sakaiproject.entitybroker.providers.EntityPropertiesService: Get a property for an entity if one is available
getProperty(String, String, Locale, String) - Method in interface org.sakaiproject.entitybroker.providers.EntityPropertiesService: Get a property for an entity if one is available
getPropertyValue(String, String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider: Retrieve a meta property value for a specific property name on a specific entity
getProvider(String) - Method in interface org.sakaiproject.entitybroker.access.EntityViewAccessProviderManager: Get an entity view access provider for a prefix if one exists
getProvider(String) - Method in interface org.sakaiproject.entitybroker.access.HttpServletAccessProviderManager: Deprecated.
getProviderByPrefix(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Get the entity provider by the prefix which uniquely defines all entities of a type,
NOTE: this returns the CoreEntityProvider that handles the exists check (it may handle many other things as well), the basic EntityProvider if there is no CoreEntityProvider, OR null if neither exists
getProviderByPrefixAndCapability(String, Class<T>) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Get the entity provider by the prefix which uniquely defines all entities of a type and also handles a specific capability
NOTE: this returns the provider that handles this capability (it may handle many other things as well)
getProviderByReference(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Deprecated.
this method is no longer functional or supported
getProvidersByCapability(Class<T>) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Get all the entity providers which support a specific capability, this useful if you need to get the providers and call the capability methods on them directly
getQuery() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getQueryString() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search query string which will be interpreted into search params, If not null this indicates that this is a string based "search"
The search string is just text - there is no required structure nor any modifiers.
getReference() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getReference() - Method in class org.sakaiproject.entitybroker.EntityReference: Get the string reference for this entity reference object, same as calling EntityReference.toString()
getRegisteredEntityCapabilities() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Get all registered prefixes and their capabilities, WARNING: This is very inefficient so you should normally use EntityProviderManager.getProviderByPrefixAndCapability(String, Class) when trying to determine if a provider implements a specific capability
getRegisteredPrefixes() - Method in interface org.sakaiproject.entitybroker.EntityBroker: Retrieve a complete set of all currently registered EntityProvider prefixes
getRegisteredPrefixes() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Retrieve a complete list of all currently registered EntityProviders
getRegistrationId() - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
getRequest() - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestGetter
getRequestGetter() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the current RequestGetter service
getRequestGetter() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Allows access to the current RequestGetter service
getRequestStorage() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows access to the current RequestStorageWrite service
getRequestStorage() - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Allows access to the current RequestStorage service
getResourceClassLoader() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.DescribePropertiesable: Defines the ClassLoader which will be used to load the properties bundle file/classes which contain the entity descriptions
getResourcePrefix() - Method in interface org.sakaiproject.entitybroker.event.EventReceiver: This defines the events that you want to know about by event resource (reference), receiveEvent(String, String) will be called whenever an event occurs which has a resource which begins with the string this method returns, simply return empty string to match no events this way

Note: Can be used with getEventNamePrefixes()
getResponse() - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestGetter
getResponseBody() - Method in class org.sakaiproject.entitybroker.util.EntityResponse
getResponseCode() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
getResponseCode() - Method in class org.sakaiproject.entitybroker.util.EntityResponse
getResponseHeaders() - Method in class org.sakaiproject.entitybroker.util.EntityResponse
getResponseMessage() - Method in class org.sakaiproject.entitybroker.util.EntityResponse
getRestrictionByProperties(String[]) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Finds if there are any search restrictions with one of the given properties, if so it returns the first of the found restriction, otherwise returns null
getRestrictionByProperty(String) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Convenient method to find restrictions by their property, if there happens to be more than one restriction with a property then only the first one will be returned (since that is an invalid state)
getRestrictions() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Restrictions define limitations on the results of a search, e.g. propertyA > 100 or property B = 'jump'
You can add as many restrictions as you like and they will be applied in the array order
getRestrictionsProperties() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
getRestrictionValueByProperties(String[]) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Finds if there are any search restrictions with one of the given properties, if so it returns the first non-null value in the found restrictions, otherwise returns null
getResults() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getResultsNum() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getSampleEntity() - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable: Provides a sample entity object which can be populated with data and then passed to methods like Createable.createEntity(EntityReference, Object, java.util.Map), this is necessary so that the type of the entity object is known and the right fields can be pre-filled, it also allows us to support the case of different read and write objects Note: The entity class type needs to be able to be resolved from the ClassLoader of the EntityBroker (currently this means deployed into shared)
getSampleEntityObject(String, String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Safely get the sample entity object which is defined for a prefix, if there is not one then return null
getSeparatorPos(String, int) - Static method in class org.sakaiproject.entitybroker.EntityReference
getServerURL() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getServerUrl() - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Gets the full server URL for the server which this is being used on
getServletContext() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: FOR INTERNAL USE ONLY (do not mess with this in other words) This gets the known REST servlet context if there is one, will return a default "/rest" if none is known, will not return "" or null
getSingleValue() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
getSpaceReference() - Method in class org.sakaiproject.entitybroker.EntityReference: Get the space reference for this entity reference, this ignored any id and only returns the reference to the entity space
getStart() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
getStartIndex() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getStartingLocationReference() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getStartNum() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getStorageMapCopy() - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage: Get the data as a map for easy access to the full set of keys/values, this is a copy and changing it has no effect on the data in the request
getStorageMapCopy(boolean, boolean, boolean, boolean) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage: Special version which allows getting only the parts that are desired
getStoredValue(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage: Get a value that is stored in the request for a specific key
getStoredValueAsType(Class<T>, String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage
getStringValue() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
getSuitableClassLoader() - Method in interface org.sakaiproject.entitybroker.util.ClassLoaderReporter
getSummaryReader() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getTags(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Deprecated.
use TagProvider.getTagsForEntity(String)
getTagsForEntity(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider: Get the set of tags which are associated with this entity
getTimestamp() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResult
getTitle() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
getTitle() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getTitle() - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
getToolData(String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getToolIdFromToolRef(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Translate a tool entity reference into a tool Id
getToolURL() - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
getToolViewURL(String, String, Map<String, String>, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Generate a URL to a tool which will work from anywhere and can carry parameters with it
NOTE: you should set the A tag target="_top" if you are inside an existing tool iFrame
getTotalItemsMatched() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getTotalNum() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
getUrl() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
getURLRedirects(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Get the list of all redirects for this prefix
getUserHomeLocationReference(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Get the entity reference of the location of a user's workspace/homespace
getUserHomeLocationURL(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService
getUserIdFromRef(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Translate the user entity reference into a userId
getUserReferencesForEntityReference(String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Get the user references which have the given permission in the given entity reference, this is most commonly used to get the users which have a permission in a site but it should work for any entity type which uses Sakai permissions
getUserRefFromUserEid(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Translate the user EID (username/loginname typicaly) into a user reference
getUserRefFromUserId(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Translate the userId into a user entity reference, (may or may not validate the userId first)
getValue() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction: the value of the Restriction.property (can be an array of items)
getVersionInfo() - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Used to get a version info string which can be output to see what version we are working with
getViewKey() - Method in class org.sakaiproject.entitybroker.EntityView
GREATER - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction

H

handleAccess(EntityView, HttpServletRequest, HttpServletResponse) - Method in interface org.sakaiproject.entitybroker.access.EntityViewAccessProvider: Make and return the data responses for this type of data provider for a specific entity view and entity reference (contained within the entity view), use the request to get any additional sent in information you may need or want and use the response to hold the output you generate

NOTE: If you decide that you cannot handle this access request for any reason you can either throw an EntityException to specify why OR throw a general Exception, both will kill the request entirely but the general exception will pass through the system while the EntityException will produce a handled result
handleAccess(HttpServletRequest, HttpServletResponse, EntityReference) - Method in interface org.sakaiproject.entitybroker.access.HttpServletAccessProvider: Deprecated.
Use EntityViewAccessProvider instead
handleCustomActionExecution(ActionsExecutable, EntityReference, String, Map<String, Object>, OutputStream, EntityView, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider: This will execute a custom action for an entity or space/collection of entities
This is meant for specialized usage as custom actions are typically meant to be executed by REST calls only
handleEntityAccess(HttpServletRequest, HttpServletResponse, String) - Method in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: Handles the servlet request response cycle for all direct servlet accesses, logically, we only want to let this request continue on if the entity exists AND there is an http access provider to handle it AND the user can access it (there is some auth completed already or no auth is required)
handleEntityError(HttpServletRequest, Throwable) - Method in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: Handles an error which occurs by sending an email and logging extra info about the failure
handleEntityError(HttpServletRequest, Throwable) - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Handles an error which occurs while processing an entity request, e.g. by sending an email and logging extra info about the failure
handleEntityRequest(String, String, String, Map<String, String>, Object) - Method in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider: Processes and handles an entity request without requiring servlet processing and a request/response round trip
handleRedirects(String, String, String[], Map<String, String>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectControllable: Explicitly handles all the incoming URLs which match the patterns given by RedirectControllable.defineHandledTemplatePatterns() do some processing to turn it into an outgoing URL OR just do some processing OR indicate that a failure has occurred
handleUserSessionKey(HttpServletRequest) - Method in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: Allows the external system to create a session based on a passed in session key (or other data in the request), no returns are necessary and this method can simple be left unimplemented if it is not used
Most likely all requests will not include session keys so you should not fail if one is not set in most cases
hashCode() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
hashCode() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
hashCode() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
hashCode() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order
hashCode() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
hashCode() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
hashCode() - Method in class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template
HEADER_ENTITY_ID - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: This is the name of the header which will contain the id of newly created entities
HEADER_ENTITY_REFERENCE - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: This is the name of the header which will contain the reference of created/updated entities
HEADER_ENTITY_URL - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler: This is the name of the header that will contain created/updated entities SHOW URL
headers - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Optional headers to include in the response (can use the header constants if desired: ActionReturn.Header), Example:
headers.put(Header.EXPIRES.toString(), "12378389233737");
headers.put("myHeaderKey", "my Value to put in the header");
HTML - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: HTML formatted text (text/html or application/xhtml+xml)
http://en.wikipedia.org/wiki/HTML
INPUT: POST or GET form data
OUTPUT: (X)HTML text
HTML_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
HTML_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
HttpServletAccessProvider - Interface in org.sakaiproject.entitybroker.access: Deprecated.
Use EntityViewAccessProvider instead
HttpServletAccessProviderManager - Interface in org.sakaiproject.entitybroker.access: Deprecated.
Use EntityViewAccessProviderManager instead

I

id - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
ID - Static variable in class org.sakaiproject.entitybroker.EntityView
id - Variable in class org.sakaiproject.entitybroker.IdEntityReference: Deprecated.
use EntityReference.getId() to get the id
ID - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: The entity ID marker (Example value: "123")
IdEntityReference - Class in org.sakaiproject.entitybroker: Deprecated.
Use EntityReference directly, this will be removed eventually
IdEntityReference(String) - Constructor for class org.sakaiproject.entitybroker.IdEntityReference: Deprecated.
use EntityReference(String)
IdEntityReference(String, String) - Constructor for class org.sakaiproject.entitybroker.IdEntityReference: Deprecated.
use EntityReference(String, String)
Importable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Indicates an entity provider has the capability of importing entity data that was previously exported via the Exportable 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
This is one of the capability extensions for the EntityProvider interface
importData(String, InputStream, String, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Importable: Request that an import stream be turned into real data related to the entities in this provider and associated with a specific entity (this will probably not be an entity in this provider)
incoming - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template: indicates the template is an incoming template if true, outgoing template if false
Inputable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: These entities can be entered as certain input formats which are handled automatically and translated into entity objects (of the type defined by Sampleable)
If you want to define the way the input is translated instead of using the internal methods then use InputTranslatable

NOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider
InputTranslatable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 Inputable
NOTE: throwing FormatUnsupportedException 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 IllegalStateException and the processing will be halted
isAscending() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order: if true then the return order is ascending, if false then return order is descending
isConjunction() - Method 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
isDataOnly() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
isDisplayTitleSet() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
isEmpty() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
isEmpty() - Method in class org.sakaiproject.entitybroker.EntityReference
isEntityRequestInternal(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Checks to see if the current entity request is internal (and therefore can optionally bypass some or all security), see the RequestStorage (from RequestStorable capability) for more info
isPopulated() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
isPrefixRegistered(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Check if a prefix is currently registered
isUserAdmin(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Check if this user has super admin level access (permissions)
isUserAllowedInEntityReference(String, String, String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Check if a user has a specified permission for the entity reference, primarily a convenience method for checking location permissions
itemsPerPage - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: for paging the results

J

JSON - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: JSON formatted text (application/json or text/javascript)
http://en.wikipedia.org/wiki/JSON
INPUT: JSON text
OUTPUT: JSON text
JSON_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
JSON_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
JSONP - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: JSON formatted text with JSONP callback (application/javascript)
http://en.wikipedia.org/wiki/JSON
INPUT: -not supported, see JSON- OUTPUT: JSON text with callback (jsonEntityFeed({...}) by default)
JSONP_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
JSONP_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

L

LearningTrackable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: This capability is for tracking learning events (LRS statements) related to this entity
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.
LearningTrackingProvider - Interface in org.sakaiproject.entitybroker.entityprovider.extension: This provides for tracking learning events (LRS statements) related to an entity (by prefix)
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.
LESS - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
LIKE - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
loadParseTemplates(List<TemplateParseUtil.Template>) - Method in class org.sakaiproject.entitybroker.EntityView: Override this method if creating a custom EntityView object
loadProperties(String, String, ClassLoader) - Method in interface org.sakaiproject.entitybroker.providers.EntityPropertiesService: Register the properties in this ClassLoader for this entity prefix

M

makeEntityId() - Method in class org.sakaiproject.entitybroker.EntityReference: Override this if you are making a new class to define your entity reference, called by public EntityReference.getId() method
makeEntityPrefix() - Method in class org.sakaiproject.entitybroker.EntityReference: Override this if you are making a new class to define your entity reference, called by public EntityReference.getPrefix() method
makeEntityReference(boolean) - Method in class org.sakaiproject.entitybroker.EntityReference: Override this if you are making a new class to define your entity reference
makeEntityView(EntityReference, String, String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Reduce code duplication and ensure custom templates are used
makeFullURL(String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Make a full entity URL (http://....) from just a path URL (/prefix/id.xml)
makeSerializableObject(EntityReference, Object) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.OutputSerializable: Take the entity and convert it to whatever objects (Map, List, String, etc.) that you want to output, this will be called every time that an entity is about to serialized but only if the type of object matches that of the entities handled by your provider
maxItemsToReturn - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: The maximum number of results returned after the startindex, 0 indicates the default value (all items)
mergeTemplate(String, Map<String, String>) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Takes a template and replaces the segment keys with the segment values, keys should not have {} around them yet as these will be added around each key in the segments map
methodArgTypes - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: These are the argument types found in the custom action method in order, this should not be populated manually as any value in this will be overwritten
methodArgTypes - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: (optional) These are the argument types found in the custom action method in order, this should not be populated manually as any value in this will be overwritten
Must be set if the methodName is set
methodName - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: This will be non-null if there is a custom action method which was found or identified by the annotation EntityCustomAction or if the developer has defined this explicitly
methodName - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: (optional) This will be non-null if there is a custom action method which was found or identified by the annotation EntityCustomAction or if the developer has defined this explicitly
mimeType - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: The MIME type to use for the output when it is returned

N

NOT_EQUALS - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
NOT_NULL - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
NULL - Static variable in annotation type org.sakaiproject.entitybroker.entityprovider.annotations.EntityHttpParam
NULL - Static variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction

O

Order - Class in org.sakaiproject.entitybroker.entityprovider.search: A simple bean which defines the order to return the results of a search
Example usage:
Order ota = new Order("title"); // order by title ascending
Order otd = new Order("title", false); // order by title descending
Order(String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Order: a simple order for a property which is ascending
Order(String, boolean) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Order: define an order for a property
OrderedBean - Interface in org.sakaiproject.entitybroker.collector: 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)
org.sakaiproject.entitybroker - package org.sakaiproject.entitybroker
org.sakaiproject.entitybroker.access - package org.sakaiproject.entitybroker.access
org.sakaiproject.entitybroker.collector - package org.sakaiproject.entitybroker.collector
org.sakaiproject.entitybroker.entityprovider - package org.sakaiproject.entitybroker.entityprovider
org.sakaiproject.entitybroker.entityprovider.annotations - package org.sakaiproject.entitybroker.entityprovider.annotations
org.sakaiproject.entitybroker.entityprovider.capabilities - package org.sakaiproject.entitybroker.entityprovider.capabilities
org.sakaiproject.entitybroker.entityprovider.extension - package org.sakaiproject.entitybroker.entityprovider.extension
org.sakaiproject.entitybroker.entityprovider.search - package org.sakaiproject.entitybroker.entityprovider.search
org.sakaiproject.entitybroker.event - package org.sakaiproject.entitybroker.event
org.sakaiproject.entitybroker.exception - package org.sakaiproject.entitybroker.exception
org.sakaiproject.entitybroker.providers - package org.sakaiproject.entitybroker.providers
org.sakaiproject.entitybroker.util - package org.sakaiproject.entitybroker.util
originalQuery - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: This is a holder for the original query before it is adjusted
originalReference - Variable in class org.sakaiproject.entitybroker.EntityReference
outgoingPreProcessedTemplate - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
outgoingTemplate - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: (optional) the outgoing template to place the variables into, leave null if using the methods
output - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: the data to output (should use a provided OutputStream), can be binary, leave this null if not used
Outputable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: These entities can be returned as certain output formats which are handled automatically
If you want to define the data that is returned instead of using the internal methods then use OutputFormattable

NOTE: By default all entity view requests go through to the available access providers: EntityViewAccessProvider or HttpServletAccessProvider NOTE: 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)
OutputFormattable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 Outputable
NOTE: throwing FormatUnsupportedException 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 IllegalStateException and the processing will be halted
OutputSerializable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 Outputable
outputString - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: the output data in string form, leave this null if not used

P

PARSE_TEMPLATE_KEYS - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the order that parse templates will be processed in and the set of parse template types (keys) which must be defined, the first one to match will be used when parsing in a path
parseEntityURL(String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Parses an entity URL into an entity view object, handles custom parsing templates
parseEntityURL(String) - Method in class org.sakaiproject.entitybroker.EntityView: Used to build this object after it has already been created (typically so custom templates can be inserted)
parseReference(String) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Parses an entity reference into a concrete object, of type EntityReference, or some class derived from it, for example IdEntityReference or some other class of object which is returned from ParseSpecParseable.
parseReference(String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Parses an entity reference into the appropriate reference form
parseTemplate(String, List<TemplateParseUtil.PreProcessedTemplate>) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Parse a string and attempt to match it to a template and then return the match information along with all the parsed out keys and values
PERIOD - Static variable in class org.sakaiproject.entitybroker.EntityReference
PERIOD - Static variable in class org.sakaiproject.entitybroker.EntityView
PERIOD - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
populate(Object, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Populates an object with the values in the properties map, this will not fail if the fieldName in the map is not a property on the object or the fieldName cannot be written to with the value in the object.
populateEntityData(List<EntityData>) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Add in the extra meta data (URL, title, etc.) to all entity data objects, handles it as efficiently as possible without remaking an entity view on every call, this is fail safe (i.e. it should throw no exceptions)
populateEntityData(EntityData[]) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Add in the extra meta data (URL, title, etc.) to all entity data objects, handles it as efficiently as possible without remaking an entity view on every call, this is fail safe (i.e. it should throw no exceptions)
populateInternals(String, Map<String, String>, String) - Method in class org.sakaiproject.entitybroker.EntityView: Populates the internal values based on the view key, map of segments, and extension
POST_METHOD - Static variable in interface org.sakaiproject.entitybroker.EntityBrokerManager
prefix - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
prefix - Variable in class org.sakaiproject.entitybroker.EntityReference: An entity prefix, should match with the prefix handled in an EntityProvider, uniquely identifies an entity space or entity type
WARNING: use the EntityReference.getPrefix() method rather than referring to this directly
PREFIX - Static variable in class org.sakaiproject.entitybroker.EntityView
PREFIX - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: The entity prefix marker (Example value: "myprefix")
PREFIX_VARIABLE - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
PrefixComparator() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity.PrefixComparator
preloadParseTemplates(List<TemplateParseUtil.PreProcessedTemplate>) - Method in class org.sakaiproject.entitybroker.EntityView: Special efficiency method to reduce reloading of custom templates, do not use this unless you wrote it or REALLY know what you are doing
preProcessedTemplate - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
PreProcessedTemplate(String, String, String, List<String>) - Constructor for class org.sakaiproject.entitybroker.util.TemplateParseUtil.PreProcessedTemplate
preprocessTemplate(TemplateParseUtil.Template) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: process a template into a preprocessed template which can be cached
preprocessTemplates(List<TemplateParseUtil.Template>) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Process the templates before attempting to match them, this is here so we can reduce the load of reprocessing the same templates over and over
ProcessedTemplate(String, String, String, List<String>, Map<String, String>, String) - Constructor for class org.sakaiproject.entitybroker.util.TemplateParseUtil.ProcessedTemplate
properties - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
PropertiesProvider - Interface in org.sakaiproject.entitybroker.entityprovider.extension: This simple defines the methods correctly which are shared between a set of interfaces, see PropertyProvideable for more information
property - Variable in class org.sakaiproject.entitybroker.entityprovider.search.Order: the name of the field (property) in the persisted object
property - Variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction: the name of the field (property) in the search
Propertyable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Allows entities handled by the entity provider which implements this interface to have meta properties attached to them, properties can be accessed via the EntityBroker, properties will be stored and retrieved using the internal entity property retrieval implementation
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
WARNING: 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 PropertyProvideable instead
This is one of the capability extensions for the EntityProvider interface
PropertyProvideable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 EntityBroker, properties will be stored and retrieved via the methods which are implemented in this interface
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
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 Propertyable instead
NOTE: the validity of references and parameters is checked in the broker before the call goes to the provider
This is one of the capability extensions for the EntityProvider interface

Q

query - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: The search query that was performed
QUERY_STRING - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: The value in the query string (without a leading ?)
queryField - Static variable in class org.sakaiproject.entitybroker.entityprovider.extension.QuerySearch
QuerySearch - Class in org.sakaiproject.entitybroker.entityprovider.extension: 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
QuerySearch(String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.QuerySearch
QuerySearch(String, String[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.QuerySearch
QUESTION_QUERY_STRING - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: The value in the query string (with a leading ?)

R

receiveEvent(String, String) - Method in interface org.sakaiproject.entitybroker.event.EventReceiver: This defines what should happen when an event occurs that you want to know about
Redirectable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: This entity type has the ability to define and handle configurable URLs, URLs like this can be handled and supported:
/gradebook/7890/student/70987 to view all the grades for a student from a course
/gradebook/6758/item/Quiz1 to view a particular item in a gradebook by it's human readable name
/gradebook/item/6857657 to maybe just a view an item by its unique id.
RedirectControllable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: This entity type has the ability to define and handle configurable URLs
This adds the ability to control all redirects via a central method
URLs like this can be handled and supported:
/gradebook/7890/student/70987 to view all the grades for a student from a course
/gradebook/6758/item/Quiz1 to view a particular item in a gradebook by it's human readable name
/gradebook/item/6857657 to maybe just a view an item by its unique id.
RedirectDefinable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: This entity type has the ability to define and handle configurable URLs
This adds the ability to supply a large set of simple redirects
URLs like this can be handled and supported:
/gradebook/7890/student/70987 to view all the grades for a student from a course
/gradebook/6758/item/Quiz1 to view a particular item in a gradebook by it's human readable name
/gradebook/item/6857657 to maybe just a view an item by its unique id.
reference - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
ReferenceComparator() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData.ReferenceComparator
ReferenceParseable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Indicates an entity provider has the capability of parsing its own reference string.
regex - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.PreProcessedTemplate: The regular expression to match this template exactly
registerEntityProvider(EntityProvider) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Registers an entity provider with the manager, this allows registration to happen programatically but the preferred method is to use the AutoRegisterEntityProvider instead (see the EntityProvider interface), replaces an existing entity provider which uses the same prefix and handles the same capabilities if one is already registered, does not affect other providers which handle the same prefix but handle other capabilities
NOTE: This allows developers to register providers from all over the code base without requiring all capabilities to live in the same project (i.e. allows for a large reduction in dependencies and conflicts)
registerListener(EntityProviderListener<T>, boolean) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Registers a listener which is called whenever entity providers are registered depending on the filters in the EntityProviderListener
This is particularly useful for capabilities which should/must be executed one time only and should not be called over and over OR will not do anything until they are triggered
registerPermission(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Register a permission key as a valid permission for use in Sakai, permissions will not appear unless they are registered each time Sakai starts up so you should run this in your service init method
registerProvider(String, EntityViewAccessProvider) - Method in interface org.sakaiproject.entitybroker.access.EntityViewAccessProviderManager: Register a provider as handling entity view requests and delivering responses
registerProvider(String, HttpServletAccessProvider) - Method in interface org.sakaiproject.entitybroker.access.HttpServletAccessProviderManager: Deprecated.
registerStatement(String, String, String, Boolean, Float) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.LearningTrackable: Send a simple learning activity (LRS) statement with an optional result Statements are the bread and butter of Experience API (a.k.a.
registerStatement(String, String, String, String, Boolean, Float) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.LearningTrackingProvider: Send a simple learning activity (LRS) statement with an optional result Statements are the bread and butter of Experience API (a.k.a.
remove(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.SearchProvider
removeCustomActions(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Remove any custom actions that are set for this prefix
removeTagsFromEntity(String, String[]) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider: Removes these tags from this entity, will have no effect if the tags do not exist on this entity
removeURLRedirects(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Remove any and all redirects for this prefix
RequestAware - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This is primarily intended to provide access to request parameters while operating inside the entity provider
RequestGetter - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Allows for getting to the request and response objects for the current thread
RequestGetterWrite - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Allows for getting to the request and response objects for the current thread
RequestHandler - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
WARNING: 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.)
RequestInterceptor - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
RequestStorable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This is primarily intended to provide access to request data while operating inside the entity provider without depending on servlet knowledge
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 RequestStorage object for more info
If you need to get to the servlet data see RequestAware and RequestInterceptor
RequestStorage - Interface in org.sakaiproject.entitybroker.entityprovider.extension: This allows access to values which are stored in the current request thread, these values are inaccessible outside of a request and will be destroyed when the thread ends
This also "magically" exposes all the values in the request (attributes and params) as if they were stored in the map as well, if there are conflicts then locally stored data always wins over data from the request
Standard reserved keys have values that are always available:
_locale : Locale _requestEntityReference : String _requestActive : [true,false] _requestOrigin : ['REST','EXTERNAL','INTERNAL']
RequestStorage.RequestOrigin - Enum in org.sakaiproject.entitybroker.entityprovider.extension: Indicates the origin of the current request
RequestStorage.ReservedKeys - Enum in org.sakaiproject.entitybroker.entityprovider.extension: Reserved keys with special data in them, see RequestStorage
RequestStorageWrite - Interface in org.sakaiproject.entitybroker.entityprovider.extension: This allows write access to values which are stored in the current request thread, these values are inaccessible outside of a request and will be destroyed when the thread ends
This also "magically" exposes all the values in the request (attributes and params) as if they were stored in the map as well, if there are conflicts then locally stored data always wins over data from the request
Standard reserved keys have values that are always available:
_locale : Locale _requestEntityReference : String _requestActive : [true,false] _requestOrigin : ['REST','EXTERNAL','INTERNAL']
reset() - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorageWrite: Clear all values in the request storage (does not wipe the values form the request itself)
reset() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search: Resets the search object to empty state
resetSearchIndexes(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.SearchProvider: WARNING: this should mostly never be run but it tells the search provider to purge the indexes and to request new search data for the given context
Resolvable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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)
This is also used for resolving the type of entities
This is one of the capability extensions for the EntityProvider interface
responseBody - Variable in class org.sakaiproject.entitybroker.util.EntityResponse: the body of the response
responseCode - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: The response code to send back from the processing of this action, the default which also indicates the response code as determined by the system should be used is -1
responseCode - Variable in exception org.sakaiproject.entitybroker.exception.EntityException: This is the response code related to the failure that occurred, should match with constants in HttpServletResponse
responseCode - Variable in class org.sakaiproject.entitybroker.util.EntityResponse: The http response code
responseHeaders - Variable in class org.sakaiproject.entitybroker.util.EntityResponse: The map of the response headers, this may be null
responseMessage - Variable in class org.sakaiproject.entitybroker.util.EntityResponse: The response message
RESTful - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Indicates that entities handled by this provider are RESTful as defined by the REST microformat:
http://microformats.org/wiki/rest/urls
Requires all CRUD functionality, Collection handling, HTML handling, and ability to support output formats
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
restoreCurrentUser() - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Restores the current user to the one from before DeveloperHelperService.setCurrentUser(String) was called or does nothing if there was no previous user stored
Restriction - Class in org.sakaiproject.entitybroker.entityprovider.search: A simple bean which defines a restriction in a search, this is like saying: where userId = '123'; OR where userId like '%aaronz%';
Example usage:
Restriction rteq = new Restriction("title", curTitle); // restrict search to title equals value of curTitle
Restriction rtne = new Restriction("title", curTitle, Restriction.NOT_EQUALS); // restrict search to title not equals value of curTitle
Restriction(String, Object) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Restriction: Simple restriction where the property must equal the value
Restriction(String, Object, int) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Restriction: Restriction which defines the type of comparison to make between a property and value
RSS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: RSS 2 XML feed (application/rss+xml)
http://en.wikipedia.org/wiki/RSS
INPUT: -not supported-
OUTPUT: -not supported-
RSS_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
RSS_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
run(T) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.EntityProviderListener: This method will be called once per each provider that is registered with the system depending on the filter methods in this class
WARNING: Do not hold onto (cache) the provider returned to you by this method, if you need to use it again later you should fetch it using the methods in EntityProviderManager like EntityProviderManager.getProviderByPrefix(String) and EntityProviderManager.getProviderByPrefixAndCapability(String, Class) among others, you can cache the prefix name and capabilities if you need to

S

SakaiToolData - Class in org.sakaiproject.entitybroker.util: This contains an abstraction of the information about a tool in Sakai
SakaiToolData() - Constructor for class org.sakaiproject.entitybroker.util.SakaiToolData
Sampleable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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 Map, etc.
Saveable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Convenience interface to indicates that an entity is can be saved, i.e. it is creatable and updateable
search(QuerySearch) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.SearchProvider: Do a search for entities and get back the listing of results
Search - Class in org.sakaiproject.entitybroker.entityprovider.search: This is a simple class which allows the passing of a set of search parameters in a nice way
Example usage:
Search s1 = new Search("title", curTitle); // search where title equals value of curTitle
Search s2 = new Search("title", curTitle, Restriction.NOT_EQUALS); // search where title not equals value of curTitle
Search s2 = new Search( new Restriction("title", curTitle), new Order("title") ); // search where title equals value of curTitle and order is by title ascending

Most searches can be modeled this way fairly easily.
Search() - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Empty constructor, if nothing is changed then this indicates that the search should return all items in default order
Search(Search) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Copy constructor
Use this create a duplicate of a search object
Search(String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search using a query string
Search(String, Object) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a simple search of a single property which must equal a single value
Search(String, Object, int) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a simple search of a single property with a single type of comparison
Search(String[], Object[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search of multiple properties which must equal corresponding values, all arrays should be the same length
Search(String[], Object[], boolean) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search of multiple properties which must equal corresponding values, control whether to do an AND or an OR between restrictions, all arrays should be the same length
Search(String[], Object[], int[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search of multiple properties which are compared with corresponding values, all arrays should be the same length
Search(String[], Object[], int[], boolean) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search of multiple properties which are compared with corresponding values, all arrays should be the same length
Search(String[], Object[], int[], Order[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search of multiple properties which are compared with corresponding values, sort the returned results in ascending order defined by specific sortProperties, all arrays should be the same length
Search(String[], Object[], int[], Order[], long, long) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Do a search of multiple properties which are compared with corresponding values, sort the returned results in ascending order defined by specific sortProperties, all arrays should be the same length
Search(Restriction) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines only a single restriction, defaults to AND restriction comparison and returning all results
Search(Restriction[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines only restrictions, defaults to AND restriction comparisons and returning all results
Search(Restriction, Order) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines only a single restriction and returns all items, defaults to AND restriction comparisons
Search(Restriction[], Order) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines restrictions and return ordering, defaults to AND restriction comparisons and returning all results
Search(Restriction[], Order[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines restrictions and return ordering, defaults to AND restriction comparisons and returning all results
Search(Restriction, Order, long, long) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines only a single restriction and limits the returns, defaults to AND restriction comparisons
Search(Restriction[], Order, long, long) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines restrictions and return ordering and limits the returns, defaults to AND restriction comparisons
Search(Restriction[], Order[], long, long) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines restrictions and return ordering and limits the returns, defaults to AND restriction comparisons
Search(Restriction[], Order, long, long, boolean) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines restrictions and return ordering and limits the returns, also specifies the types of restriction comparisons (AND or OR)
Search(Restriction[], Order[], long, long, boolean) - Constructor for class org.sakaiproject.entitybroker.entityprovider.search.Search: Defines a search which defines restrictions and return ordering and limits the returns, also specifies the types of restriction comparisons (AND or OR)
SEARCH_LOCATION_REFERENCE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable: A search key which indicates the results should be limited by the unique reference for a location (site, group, etc.)
SEARCH_TAGS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable: A search key which indicates the results should be limited by a tag or an array of tags
SEARCH_USER_REFERENCE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable: A search key which indicates the results should be limited by the unique reference for a user
Searchable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
If you need to force an entity or entities to be added to the search indexes then you should use the SearchProvider.add(String, org.sakaiproject.entitybroker.entityprovider.extension.SearchContent) method in the system core to cause immediate indexing
This is one of the capability extensions for the EntityProvider interface
SearchContent - Class in org.sakaiproject.entitybroker.entityprovider.extension: 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
SearchContent() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
SearchContent(String, String, String, String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent: Create a set of content for indexing, NOTE: make sure you also set the summary using SearchContent.setSummary(String) or SearchContent.setSummaryReader(Reader)
SearchProvider - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Defines the methods related to searching for entities (shared between interfaces), implementing this allows for support for the core EB search functionality
SearchResult - Class in org.sakaiproject.entitybroker.entityprovider.extension: This is a single search result
SearchResult() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchResult
SearchResult(String, String, String, String, String, Date, Map<String, Object>) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchResult
SearchResult(SearchContent) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchResult
SearchResults - Class in org.sakaiproject.entitybroker.entityprovider.extension: This represents the return data from a search
SearchResults() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
SearchResults(String, int, int) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
SearchResults(int, int, int, List<SearchResult>) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: use this constructor to build search results manually
segmentValues - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.ProcessedTemplate: The list of segment values (variableName -> matched value), this will be filled in by the TemplateParseUtil#parseTemplate(String, Map) method and will be null otherwise
SEPARATOR - Static variable in class org.sakaiproject.entitybroker.EntityReference
SEPARATOR - Static variable in class org.sakaiproject.entitybroker.EntityView
SEPARATOR - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
serialVersionUID - Static variable in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity.PrefixComparator
serialVersionUID - Static variable in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity.TitleComparator
serialVersionUID - Static variable in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData.ReferenceComparator
serialVersionUID - Static variable in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData.TitleComparator
serialVersionUID - Static variable in class org.sakaiproject.entitybroker.EntityReference
serialVersionUID - Static variable in class org.sakaiproject.entitybroker.EntityView
SESSION_ID - Static variable in interface org.sakaiproject.entitybroker.providers.ExternalIntegrationProvider: The recommended param key to use for sending in session ids in requests
setAscending(boolean) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order
setCollectedBeans(List<T>) - Method in interface org.sakaiproject.entitybroker.collector.BeanCollector: This setter will be called automatically and the beans which are being collected for you will be placed in the List
setCollectedBeansMap(Map<Class<?>, List<?>>) - Method in interface org.sakaiproject.entitybroker.collector.BeanMapCollector: This setter will be called automatically and the beans which are being collected for you will be placed in the map such that it is a map of class type -> list of beans of that type
setComparison(int) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
setConjunction(boolean) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
setCurrentUser(String) - Method in interface org.sakaiproject.entitybroker.DeveloperHelperService: Set the current user to match the supplied user reference, the current user reference will be stored and returned (may be null), this is primarily useful when you need to switch a user to an admin or to some other user temporarily OR there is no current user but something you are calling expects to find one
setCustomActions(String, Map<String, CustomAction>) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderMethodStore: Set the custom actions for this prefix
setData(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
setDataOnly(boolean) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: FOR INTERNAL USE ONLY - do not use
setDescription(String) - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
setDisplayTitle(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: A string which is suitable for display and provides a short summary of the entity, typically 100 chars or less, this may be the name or title of the data represented by an entity
setEntityProperties(Map<String, Object>) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: (OPTIONAL - may be null) A set of properties to return along with the entity information, this may be presented and used for filtering, should be null or empty if not used
setEntityReference(EntityReference) - Method in class org.sakaiproject.entitybroker.EntityView: Allows for easy chained construction of EntityViews by setting an EntityReference, does not set the viewkey or extension unless they are unset, maintains current extension
setEntityRESTProvider(EntityRESTProvider) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows the developer to set a REST provider to add functionality to the EntityBroker system from a REST handler, the system will operate without this set but some methods will fail
setEntityURL(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: WARNING: for internal use only
setEntityViewKeys(String[]) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
setExtension(String) - Method in class org.sakaiproject.entitybroker.EntityView
setExternalIntegrationProvider(ExternalIntegrationProvider) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: Allows developers to setup providers to handle parts of the EB system which cannot really be handled internally, the system will operate without this set
setFormat(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Indicates the format (from Formats) to return the entity data in if there is any, if using an outputstream, use encoding and mimetype
setHeaders(Map<String, String>) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn: Set the optional headers to include in the response (can use the header constants if desired: ActionReturn.Header), Example:
headers.put(Header.EXPIRES.toString(), "12378389233737");
headers.put("myHeaderKey", "my Value to put in the header");
setHighlights(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResult
setId(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setIncomingTemplate(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap
setItemsPerPage(int) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
setLimit(long) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
setLocationReference(String) - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
setMethod(Method) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: INTERNAL USE ONLY
setMethod(Method) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: INTERNAL USE ONLY
setMethod(EntityView.Method) - Method in class org.sakaiproject.entitybroker.EntityView
setNestedPrefixes(String[]) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
setOrders(Order[]) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
setOriginalEntityURL(String) - Method in class org.sakaiproject.entitybroker.EntityView
setOriginalQuery(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults
setOriginalReference(String) - Method in class org.sakaiproject.entitybroker.EntityReference
setOutgoingTemplate(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap
setParentPrefix(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
setPlacementId(String) - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
setPopulated(boolean) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData: FOR INTERNAL USE ONLY - do not use
setPrefix(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setProperty(String, String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent: Set any property on this search content
setProperty(String) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order
setProperty(String) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
setPropertyValue(String, String, String) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider: Set a meta property value on a specific entity, setting a value to null will remove the related value from persistence, passing the name and value as null will remove all the properties for this entity from persistence
Note: Do not use this as a substitute for storing core meta data on your actual persistent entities, this is meant to provide for the case where runtime properties need to be added to an entity, persisted, and later retrieved and should be seen as a lazy way to expand the fields of a persistent entity
setQueryString(String) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
setReference(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setRegistrationId(String) - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
setRequest(HttpServletRequest) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestGetterWrite: Sets the request for the current thread, this will be cleared when the thread closes
setRequestGetter(RequestGetter) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware: Allows the entity provider to access the current request if it is available, sets a getter service which will retrieve the current request/response if there is one
NOTE: this will only be the current request at the instant that the methods on the getter service are called
setRequestStorage(RequestStorage) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable: Allows the entity provider to access the current request storage if available, sets a storage service which will retrieve or set the stored data values
NOTE: this will only access data from the current request at the time the call is made, values disappear as soon as the request ends
setRequestValue(String, Object) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorageWrite: Allows user to set the value of a key directly, including reserved keys
setRequestValues(Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorageWrite: Place all these params into the request storage
setResponse(HttpServletResponse) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestGetterWrite: Sets the response for the current thread, this will be closed when the thread closes
setResponseCode(int) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
setRestrictions(Restriction[]) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
setServletContext(String) - Method in interface org.sakaiproject.entitybroker.EntityBrokerManager: FOR INTERNAL USE ONLY (do not mess with this in other words)
setStart(long) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
setStoredValue(String, Object) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.RequestStorageWrite: Store a value in the request storage with an associated key
setSummary(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setSummaryReader(Reader) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setTags(String, String[]) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Deprecated.
use TagProvider.setTagsForEntity(String, String[])
setTagsForEntity(String, String[]) - Method in interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider: Sets the tags which are associated with this entity, this overwrites any current tags and makes the input tags the only current tags for this entity
setTemplate(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
SETTING_AUTO_DDL - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService: Boolean type: if true then there will be data preloads and DDL creation, if false then data preloads are disabled (and will cause exceptions if preload data is missing)
SETTING_PORTAL_URL - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService: String type: gets the URL to the portal on this server (or just returns the server URL if no portal in use)
SETTING_SERVER_ID - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService: String type: gets the unique id of this server (safe for clustering if used)
SETTING_SERVER_NAME - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService: String type: gets the printable name of this server
SETTING_SERVER_URL - Static variable in interface org.sakaiproject.entitybroker.DeveloperHelperService: String type: gets the URL to this server
setTitle(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setTitle(String) - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
setTitleDesc(String, String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
setToolURL(String) - Method in class org.sakaiproject.entitybroker.util.SakaiToolData
setUrl(String) - Method in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
setValue(Object) - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
setViewKey(String) - Method in class org.sakaiproject.entitybroker.EntityView
SLASH_BATCH - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler
SLASH_DESCRIBE - Static variable in interface org.sakaiproject.entitybroker.providers.EntityRequestHandler
startIndex - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: The index (position) of the result item to started on (used for paging)
0 indicates the default value (start at the beginning)
Statisticable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
Contact Nuno Fernandes (nuno@ufp.edu.pt) if you have questions
This is one of the capability extensions for the EntityProvider interface
summary - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
summaryReader - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent

T

Taggable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This uses the internal tag storage mechanism or a central tag storage mechanism to store the tag applications
This is one of the capability extensions for the EntityProvider interface
TagProvideable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This is the provider interface for Taggable, inherits all methods from TagProvider
This is one of the capability extensions for the EntityProvider interface
TagProvider - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Defines the methods related to tagging entities (shared between interfaces)
TagSearchable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: Deprecated.
no longer functional, use TagProvideable
TagSearchProvider - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Deprecated.
use TagProvideable and TagProvider instead
TagSearchService - Interface in org.sakaiproject.entitybroker.entityprovider.extension: Defines the methods necessary for searching for entities by tags (shared interface)
template - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: The incoming url template the URL pattern to match AFTER the /prefix using {name} to indicate variables
Example: /{thing}/site/{siteId} will match the following URL:
/myprefix/123/site/456, the variables will be {prefix => myprefix, thing => 123, siteId => 456}
Template(String, String) - Constructor for class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template: Used to create a template for loading, defaults to an incoming template
Template(String, String, boolean) - Constructor for class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template: Used to create a template for loading
template - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template: the template itself
TEMPLATE_DELETE - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the parse template for the "delete" operation, access the data to remove a record, typically /{prefix}/{id}/delete
TEMPLATE_EDIT - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the parse template for the "edit" operation, access the data to modify a record, typically /{prefix}/{id}/edit
TEMPLATE_LIST - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the parse template for the "list" operation, return a list of all records, typically /{prefix}
TEMPLATE_NEW - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the parse template for the "new" operation, return a form for creating a new record, typically /{prefix}/new
TEMPLATE_PREFIX - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil
TEMPLATE_SHOW - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the parse template for the "show" operation, access a record OR POST operations related to a record, typically /{prefix}/{id}
templateKey - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.Template: the template key, from the set of template keys TemplateParseUtil.PARSE_TEMPLATE_KEYS, or make one up for your own templates, should be unique for this set of templates
TemplateMap - Class in org.sakaiproject.entitybroker.entityprovider.extension: An object to hold the incoming and outgoing templates in pairs, used with RedirectDefinable
TemplateMap(String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap
TemplateParseUtil - Class in org.sakaiproject.entitybroker.util: Utility class to handle the URL template parsing (entity template parsing)
TemplateParseUtil() - Constructor for class org.sakaiproject.entitybroker.util.TemplateParseUtil
TemplateParseUtil.PreProcessedTemplate - Class in org.sakaiproject.entitybroker.util: Contains the data for templates, each template must have a template key and the template itself
TemplateParseUtil.ProcessedTemplate - Class in org.sakaiproject.entitybroker.util: Contains the processed template with the values from the processed input string that was determined to be related to this template
TemplateParseUtil.Template - Class in org.sakaiproject.entitybroker.util: Represents a parseable template (which is basically a key and the template string), the array which defines the set of template keys is TemplateParseUtil.PARSE_TEMPLATE_KEYS
Rules for parse templates: 1) "{","}", and TemplateParseUtil.SEPARATOR are special characters and must be used as indicated only 2) Must begin with a TemplateParseUtil.SEPARATOR, must not end with a TemplateParseUtil.SEPARATOR 3) must begin with "/{prefix}" (use the TemplateParseUtil.SEPARATOR and TemplateParseUtil.PREFIX 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 TemplateParseUtil.VALID_VAR_CHARS 6) parse templates can only have the chars from TemplateParseUtil.VALID_TEMPLATE_CHARS 7) Empty braces ({}) cannot appear in the template
title - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
TitleComparator() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity.TitleComparator
TitleComparator() - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.EntityData.TitleComparator
toString() - Method in enum org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn.Header
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.BrowseEntity
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.EntityData
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Order
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Restriction
toString() - Method in class org.sakaiproject.entitybroker.entityprovider.search.Search
toString() - Method in class org.sakaiproject.entitybroker.EntityReference
toString() - Method in class org.sakaiproject.entitybroker.EntityView
totalItemsMatched - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchResults: The total number of items matched by the search
translateFormattedData(EntityReference, String, InputStream, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.InputTranslatable: Translates the input data stream in the supplied format into an entity object for this reference
translateInputToEntity(String, String, InputStream, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.EntityBroker: Translates the input data stream in the supplied format into an entity object for this reference
translateInputToEntity(EntityReference, String, InputStream, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider: Translates the input data stream in the supplied format into an entity object for this reference
translateViewKeyToMethod(String) - Static method in class org.sakaiproject.entitybroker.EntityView: Translate a viewkey into an http method
TXT - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: Plain text (text/plain)
http://en.wikipedia.org/wiki/Plain_text
INPUT: -not supported-
OUTPUT: text
TXT_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
TXT_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

U

unloadProperties(String) - Method in interface org.sakaiproject.entitybroker.providers.EntityPropertiesService: Unregister the properties stored for this prefix
unregisterCapability(String, Class<? extends EntityProvider>) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Unregisters an entity provider with the manager based on a prefix and capability, this will remove a registered entity broker from the manager registration, if the prefix and capability are not registered then no error is thrown
NOTE: Attempting to unregister the base EntityProvider will cause an exception, if you want to completely unregister a type of entity you must use the EntityProviderManager.unregisterEntityProviderByPrefix(String)
unregisterEntityProvider(EntityProvider) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Unregisters an entity provider with the manager, this will remove a registered entity broker from the manager registration, if the entity provider supplied is not registered then no error is thrown
unregisterEntityProviderByPrefix(String) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Unregisters an entity provider with the manager based on the entity prefix it handles, this will remove all registered entity providers from the manager registration by the prefix, if the entity provider prefix provided is not registered then no error is thrown
This effectively purges the entire set of entity providers for a prefix
unregisterListener(EntityProviderListener<T>) - Method in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderManager: Unregisters the listener if it is registered or does nothing
unregisterProvider(String) - Method in interface org.sakaiproject.entitybroker.access.EntityViewAccessProviderManager: Removes the provider from the registered set for this prefix
unregisterProvider(String, HttpServletAccessProvider) - Method in interface org.sakaiproject.entitybroker.access.HttpServletAccessProviderManager: Deprecated.
Updateable - Interface in org.sakaiproject.entitybroker.entityprovider.capabilities: 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
This is one of the capability extensions for the EntityProvider interface
updateEntity(EntityReference, Object, Map<String, Object>) - Method in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable: Update an existing entity, the object should contain the data needed to update the entity or this will fail
Typically the entity will be retrieved first using Resolvable.getEntity(EntityReference) and the the fields will be updated and it will be passed into this method
url - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.SearchContent
URLRedirect - Class in org.sakaiproject.entitybroker.entityprovider.extension: Storage for the redirects
URLRedirect(String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect: Use this for controllable template matches only
URLRedirect(String, String) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
URLRedirect(String, String, Class<?>[]) - Constructor for class org.sakaiproject.entitybroker.entityprovider.extension.URLRedirect
UTF_8 - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: All character data should be encoded and decoded as UTF-8, this constant is the proper encoding string to use

V

VALID_INPUT_CHARS - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the valid chars for a parser input (e.g. entity reference)
VALID_TEMPLATE_CHARS - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the valid chars for a template
VALID_TEMPLATE_CHARS_OUTGOING - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the valid template chars for an outgoing template (allows ?)
VALID_VAR_CHARS - Static variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Defines the valid chars for a replacement variable
validateOutgoingTemplate(String) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Validates an outgoing template to make sure it is valid
validateTemplate(String) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Validate a template, if invalid then an exception is thrown
validateTemplateKey(String) - Static method in class org.sakaiproject.entitybroker.util.TemplateParseUtil: Check if a templateKey is valid, if not then throws IllegalArgumentException
value - Variable in class org.sakaiproject.entitybroker.entityprovider.search.Restriction: the value of the Restriction.property (can be an array of items)
valueOf(String) - Static method in enum org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn.Header: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage.RequestOrigin: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage.ReservedKeys: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sakaiproject.entitybroker.EntityView.Method: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn.Header: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage.RequestOrigin: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage.ReservedKeys: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sakaiproject.entitybroker.EntityView.Method: Returns an array containing the constants of this enum type, in the order they are declared.
variableNames - Variable in class org.sakaiproject.entitybroker.util.TemplateParseUtil.PreProcessedTemplate: The list of variable names found in this template
VIEW_DELETE - Static variable in class org.sakaiproject.entitybroker.EntityView: Defines the view for the "delete" (destroy) operation, remove an entity or access a form for removing an entity, represents a EntityView.Method.DELETE to a specific entity
VIEW_EDIT - Static variable in class org.sakaiproject.entitybroker.EntityView: Defines the view for the "edit" (update) operation, update an entity or access a form for updating an entity, represents a EntityView.Method.PUT (or POST) to a specific entity, also indicates an action related to writing a specific entity
VIEW_LIST - Static variable in class org.sakaiproject.entitybroker.EntityView: Defines the view for the "list" (index) or collection operation, access a list/collection of all entities of a type (possibly filtered by search params), represents a EntityView.Method.GET to the entity space/collection, also indicates an action related to reading a collection of entities
VIEW_NEW - Static variable in class org.sakaiproject.entitybroker.EntityView: Defines the view for the "new" (create) operation, create a new record or access a form for creating a new record, represents a EntityView.Method.POST (or PUT) to the entity space/collection, also indicates an action related to writing a collection of entities
VIEW_SHOW - Static variable in class org.sakaiproject.entitybroker.EntityView: Defines the view for the "show" (read) operation, access data or a view of an entity, represents a EntityView.Method.GET to a specific entity, also indicates an action related to reading a specific entity
viewKey - Variable in class org.sakaiproject.entitybroker.entityprovider.extension.CustomAction: (optional) Must match one of the VIEW constants from EntityView
The view type which this action goes with, this roughly translates to the GET/POST/PUT/DELETE in http
e.g.

X

XML - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats: XML formatted text (application/xml or text/xml)
http://en.wikipedia.org/wiki/XML
INPUT: XML text
OUTPUT: XML text
XML_EXTENSIONS - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats
XML_MIME_TYPE - Static variable in interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

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