Interface BrowseableCollection
-
- All Superinterfaces:
Browseable,CollectionResolvable,EntityProvider,Resolvable
public interface BrowseableCollection extends Browseable, CollectionResolvable
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 toCollectionResolvableto 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 ofCollectionResolvable.getEntities(org.sakaiproject.entitybroker.EntityReference, org.sakaiproject.entitybroker.entityprovider.search.Search)
This is one of the capability extensions for theEntityProviderinterface
SeeBrowseablefor the i18n keys
This extendsCollectionResolvable, use theBrowseSearchableinterface if you require more control- Author:
- Aaron Zeckoski (azeckoski @ gmail.com)
-
-
Field Summary
-
Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Browseable
BROWSE_DESC_KEY, BROWSE_TITLE_KEY
-
Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
SEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCE
-
-
Method Summary
-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
getEntities
-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider
getEntityPrefix
-
Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
getEntity
-
-