Uses of Class
org.sakaiproject.entitybroker.entityprovider.search.Search
-
-
Uses of Search in org.sakaiproject.entitybroker
Methods in org.sakaiproject.entitybroker with parameters of type Search 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<?>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<?>EntityBrokerManager. fetchEntities(EntityReference ref, Search search, Map<String,Object> params)Get a list of entities fromCollectionResolvablefirst if available orBrowseSearchableif not, returns the entities as actual entities (converts fromEntityDataif that was used), correctly handles references to single entities as wellList<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 well -
Uses of Search in org.sakaiproject.entitybroker.entityprovider.capabilities
Methods in org.sakaiproject.entitybroker.entityprovider.capabilities with parameters of type Search 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 keysStringExportable. 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/groupList<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/123List<?>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. -
Uses of Search in org.sakaiproject.entitybroker.entityprovider.extension
Subclasses of Search in org.sakaiproject.entitybroker.entityprovider.extension Modifier and Type Class Description classQuerySearchAn extension of the standard search object which allows for custom constructors to make it easier to build up the search for the search queryMethods in org.sakaiproject.entitybroker.entityprovider.extension with parameters of type Search 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 search -
Uses of Search in org.sakaiproject.entitybroker.entityprovider.search
Methods in org.sakaiproject.entitybroker.entityprovider.search that return Search Modifier and Type Method Description static SearchSearch. copy(Search original, Search copy)Make a copy of a search objectMethods in org.sakaiproject.entitybroker.entityprovider.search with parameters of type Search Modifier and Type Method Description static SearchSearch. copy(Search original, Search copy)Make a copy of a search objectConstructors in org.sakaiproject.entitybroker.entityprovider.search with parameters of type Search Constructor Description Search(Search search)Copy constructor
Use this create a duplicate of a search object
-