org.sakaiproject.util
Interface MergedList.EntryProvider

All Known Implementing Classes:
MergedListEntryProviderBase, MergedListEntryProviderFixedListWrapper
Enclosing interface:
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.
 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.
 Site getSite(Object channel)
           
 String getSiteUserId(Object channel)
           
 boolean isSpecialSite(Object channel)
           
 boolean isUserChannel(Object channel)
           
 

Method Detail

getIterator

public Iterator getIterator()
Gets an iterator for the channels, calendars, etc.


allowGet

public boolean allowGet(String ref)
See if we can do a "get" on the calendar, channel, etc.


getContext

public String getContext(Object obj)
Generically access the context of the resource provided by the getIterator() call.

Returns:
The context.

getReference

public String getReference(Object obj)
Generically access the reference of the resource provided by the getIterator() call.


getProperties

public ResourceProperties getProperties(Object obj)
Generically access the resource's properties.

Returns:
The resource's properties.

isUserChannel

public boolean isUserChannel(Object channel)

isSpecialSite

public boolean isSpecialSite(Object channel)

getSiteUserId

public String getSiteUserId(Object channel)

getSite

public Site getSite(Object channel)