| 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<?> |
EntityBrokerManager.fetchEntities(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 as actual entities (converts from EntityData if that was used),
correctly handles references to single entities as well |
List<?> |
EntityBroker.fetchEntities(String prefix,
Search search,
Map<String,Object> params)
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. |
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 |
|---|---|
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 |
String |
Exportable.exportData(String reference,
Search search,
OutputStream data,
boolean destructive,
Map<String,Object> params)
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 |
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 |
List<?> |
CollectionResolvable.getEntities(EntityReference ref,
Search search)
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. |
| Modifier and Type | Class and Description |
|---|---|
class |
QuerySearch
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
|
| 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
|
| Modifier and Type | Method and Description |
|---|---|
static Search |
Search.copy(Search original,
Search copy)
Make a copy of a search object
|
| Modifier and Type | Method and Description |
|---|---|
static Search |
Search.copy(Search original,
Search copy)
Make a copy of a search object
|
| Constructor and Description |
|---|
Search(Search search)
Copy constructor
Use this create a duplicate of a search object |
Copyright © 2007-2015 Sakai Project. All Rights Reserved.