Uses of Class
org.sakaiproject.entitybroker.entityprovider.extension.EntityData
-
-
Uses of EntityData in org.sakaiproject.entitybroker
Methods in org.sakaiproject.entitybroker that return EntityData Modifier and Type Method Description EntityDataEntityBrokerManager. convertToEntityData(Object entity, EntityReference ref)Convert a single object to an entity data object (also populates it), will preserve null (i.e. null in => null out)EntityDataEntityBroker. getEntity(String reference)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 propertiesEntityDataEntityBrokerManager. getEntityData(EntityReference ref)Get the entity data for a reference if possibleMethods in org.sakaiproject.entitybroker that return types with arguments of type EntityData Modifier and Type Method Description List<EntityData>EntityBroker. browseEntities(String prefix, Search search, String userReference, String associatedReference, String parentReference, Map<String,Object> params)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 listList<EntityData>EntityBrokerManager. browseEntities(String prefix, Search search, String userReference, String associatedReference, EntityReference parentEntityRef, Map<String,Object> params)Fetches the browseable entitiesList<EntityData>EntityBrokerManager. convertToEntityData(List<?> entities, EntityReference ref)Convert a list of objects to entity data objects (also populates them), will preserve null (i.e. null in => null out)List<EntityData>EntityBroker. findEntitesByTags(String[] tags, String[] prefixes, boolean matchAll, Search search, Map<String,Object> params)Search for all entities which have the given tags, can limit the return using the search objectList<EntityData>EntityBroker. getEntities(String prefix, Search search, Map<String,Object> params)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 listList<EntityData>EntityBrokerManager. getEntitiesData(EntityReference ref, Search search, Map<String,Object> params)Get a list of entities fromCollectionResolvablefirst if available orBrowseSearchableif not, returns the entities wrapped inEntityData, correctly handles references to single entities as wellMethods in org.sakaiproject.entitybroker with parameters of type EntityData Modifier and Type Method Description voidEntityBrokerManager. populateEntityData(EntityData[] data)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)Method parameters in org.sakaiproject.entitybroker with type arguments of type EntityData Modifier and Type Method Description voidEntityBrokerManager. populateEntityData(List<EntityData> data)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) -
Uses of EntityData in org.sakaiproject.entitybroker.entityprovider.capabilities
Methods in org.sakaiproject.entitybroker.entityprovider.capabilities that return types with arguments of type EntityData Modifier and Type Method Description List<EntityData>BrowseSearchable. browseEntities(Search search, String userReference, String associatedReference, Map<String,Object> params)Returns the list of entities which are being browsed based on the given parameters
SeeBrowseablefor the i18n keysList<EntityData>TagProvideable. findEntitesByTags(String[] tags, boolean matchAll, Search search)Search for all entities which have the given tags, can limit the return using the search object
NOTE: Don't forget to check theRequestStorablerequest params for extra information about the current user and location and other possible params when implementing thisList<EntityData>BrowseNestable. getChildrenEntities(EntityReference parentRef, Search search, String userReference, String associatedReference, Map<String,Object> params)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/123Method parameters in org.sakaiproject.entitybroker.entityprovider.capabilities with type arguments of type EntityData Modifier and Type Method Description voidOutputFormattable. formatOutput(EntityReference ref, String format, List<EntityData> entities, Map<String,Object> params, OutputStream output)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 theEntityDataobjects 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) -
Uses of EntityData in org.sakaiproject.entitybroker.entityprovider.extension
Fields in org.sakaiproject.entitybroker.entityprovider.extension declared as EntityData Modifier and Type Field Description EntityDataActionReturn. entityDataAn entity object to return, leave as null if not usedFields in org.sakaiproject.entitybroker.entityprovider.extension with type parameters of type EntityData Modifier and Type Field Description List<EntityData>ActionReturn. entitiesListA List of entities to return, leave as null if not usedMethods in org.sakaiproject.entitybroker.entityprovider.extension that return EntityData Modifier and Type Method Description EntityDataActionReturn. getEntityData()Methods in org.sakaiproject.entitybroker.entityprovider.extension that return types with arguments of type EntityData Modifier and Type Method Description List<EntityData>TagSearchService. findEntitesByTags(String[] tags, String[] prefixes, boolean matchAll, Search search)Search for all entities with a set of tags, prefixes, and a searchList<EntityData>ActionReturn. getEntitiesList()Methods in org.sakaiproject.entitybroker.entityprovider.extension with parameters of type EntityData Modifier and Type Method Description intEntityData.ReferenceComparator. compare(EntityData o1, EntityData o2)intEntityData.TitleComparator. compare(EntityData o1, EntityData o2)Constructors in org.sakaiproject.entitybroker.entityprovider.extension with parameters of type EntityData Constructor Description ActionReturn(EntityData entityData, String format)Create a return that is appropriate for sending back an entityConstructor parameters in org.sakaiproject.entitybroker.entityprovider.extension with type arguments of type EntityData Constructor Description ActionReturn(List<EntityData> entitiesList, String format)Create a return that is appropriate for sending back a list of entities -
Uses of EntityData in org.sakaiproject.entitybroker.providers
Method parameters in org.sakaiproject.entitybroker.providers with type arguments of type EntityData Modifier and Type Method Description voidEntityRESTProvider. formatAndOutputEntity(EntityReference ref, String format, List<EntityData> entities, OutputStream outputStream, Map<String,Object> params)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)
-