| Modifier and Type | Method and Description |
|---|---|
EntityData |
EntityBrokerManager.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)
|
EntityData |
EntityBroker.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 properties
|
EntityData |
EntityBrokerManager.getEntityData(EntityReference ref)
Get the entity data for a reference if possible
|
| Modifier and Type | Method and Description |
|---|---|
List<EntityData> |
EntityBrokerManager.browseEntities(String prefix,
Search search,
String userReference,
String associatedReference,
EntityReference parentEntityRef,
Map<String,Object> params)
Fetches the browseable entities
|
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 list |
List<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 object
|
List<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 list |
List<EntityData> |
EntityBrokerManager.getEntitiesData(EntityReference ref,
Search search,
Map<String,Object> params)
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 |
| Modifier and Type | Method and Description |
|---|---|
void |
EntityBrokerManager.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)
|
| Modifier and Type | Method and Description |
|---|---|
void |
EntityBrokerManager.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)
|
| Modifier and Type | Method and 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
See Browseable for the i18n keys |
List<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 the RequestStorable request params for extra information
about the current user and location and other possible params when implementing this |
List<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/123 |
| Modifier and Type | Method and Description |
|---|---|
void |
OutputFormattable.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 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) |
| Modifier and Type | Field and Description |
|---|---|
EntityData |
ActionReturn.entityData
An entity object to return, leave as null if not used
|
| Modifier and Type | Field and Description |
|---|---|
List<EntityData> |
ActionReturn.entitiesList
A List of entities to return, leave as null if not used
|
| Modifier and Type | Method and Description |
|---|---|
EntityData |
ActionReturn.getEntityData() |
| Modifier and Type | Method and 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 search
|
List<EntityData> |
ActionReturn.getEntitiesList() |
| Modifier and Type | Method and Description |
|---|---|
int |
EntityData.ReferenceComparator.compare(EntityData o1,
EntityData o2) |
int |
EntityData.TitleComparator.compare(EntityData o1,
EntityData o2) |
| Constructor and Description |
|---|
ActionReturn(EntityData entityData,
String format)
Create a return that is appropriate for sending back an entity
|
| Constructor and Description |
|---|
ActionReturn(List<EntityData> entitiesList,
String format)
Create a return that is appropriate for sending back a list of entities
|
| Modifier and Type | Method and Description |
|---|---|
void |
EntityRESTProvider.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)
|
Copyright © 2007–2020 Sakai Project. All rights reserved.