org.sakaiproject.entitybroker.entityprovider.capabilities
Interface Browseable

All Superinterfaces:

EntityProvider

All Known Subinterfaces:

BrowseableCollection, BrowseNestable, BrowseSearchable

public interface Browseable
extends EntityProvider

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
This is the root interface for browsing entities and does not do anything by itself, you must add at least BrowseableCollection or BrowseSearchable interface to this
If your entities are nested then the nested ones will need to implement BrowseNestable
Entities which do not implement this will not appear in lists of entities which are being browsed
Internationalization keys:
{prefix}.browse = the name to show in the browse list for this entity
{prefix}.browse.description = the optional description that is viable to show in the browse list for this entity

This is one of the capability extensions for the EntityProvider interface

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Field Summary

static String	BROWSE_DESC_KEY
static String	BROWSE_TITLE_KEY

Method Summary

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Field Detail

BROWSE_TITLE_KEY

static final String BROWSE_TITLE_KEY

See Also:

Constant Field Values

BROWSE_DESC_KEY

static final String BROWSE_DESC_KEY

See Also:

Constant Field Values