org.sakaiproject.util
Interface MergedList.EntryProvider

All Known Implementing Classes:

MergedListEntryProviderBase, MergedListEntryProviderFixedListWrapper

Enclosing class:

MergedList

public static interface MergedList.EntryProvider

This interface is used to describe a generic list entry provider so that a variety of list entries can be used. This currently serves merged sites for the schedule and merged channels for announcements.

Method Summary

boolean	allowGet(String ref) See if we can do a "get" on the calendar, channel, etc.
String	getContext(Object obj) Generically access the context of the resource provided by the getIterator() call.
Iterator	getIterator() Gets an iterator for the channels, calendars, etc.
org.sakaiproject.entity.api.ResourceProperties	getProperties(Object obj) Generically access the resource's properties.
String	getReference(Object obj) Generically access the reference of the resource provided by the getIterator() call.
org.sakaiproject.site.api.Site	getSite(Object channel)
String	getSiteUserId(Object channel)
boolean	isSpecialSite(Object channel)
boolean	isUserChannel(Object channel)

Method Detail

getIterator

Iterator getIterator()

Gets an iterator for the channels, calendars, etc.

allowGet

boolean allowGet(String ref)

See if we can do a "get" on the calendar, channel, etc.

getContext

String getContext(Object obj)

Generically access the context of the resource provided by the getIterator() call.

Returns:

The context.

getReference

String getReference(Object obj)

Generically access the reference of the resource provided by the getIterator() call.

getProperties

org.sakaiproject.entity.api.ResourceProperties getProperties(Object obj)

Generically access the resource's properties.

Returns:

The resource's properties.

isUserChannel

boolean isUserChannel(Object channel)

isSpecialSite

boolean isSpecialSite(Object channel)

getSiteUserId

String getSiteUserId(Object channel)

getSite

org.sakaiproject.site.api.Site getSite(Object channel)