org.sakaiproject.util
Class MergedListEntryProviderFixedListWrapper

java.lang.Object
  extended byorg.sakaiproject.util.MergedListEntryProviderFixedListWrapper
All Implemented Interfaces:
MergedList.EntryProvider

public class MergedListEntryProviderFixedListWrapper
extends Object
implements MergedList.EntryProvider


Nested Class Summary
static interface MergedListEntryProviderFixedListWrapper.ReferenceToChannelConverter
          Defines a callback interface to convert a reference into a channel.
 
Constructor Summary
MergedListEntryProviderFixedListWrapper(MergedList.EntryProvider entryProvider, String primaryChannelReference, String[] mergedChannelsReferences, MergedListEntryProviderFixedListWrapper.ReferenceToChannelConverter refToChan)
           
 
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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MergedListEntryProviderFixedListWrapper

public MergedListEntryProviderFixedListWrapper(MergedList.EntryProvider entryProvider,
                                               String primaryChannelReference,
                                               String[] mergedChannelsReferences,
                                               MergedListEntryProviderFixedListWrapper.ReferenceToChannelConverter refToChan)
Method Detail

getIterator

public Iterator getIterator()
Description copied from interface: MergedList.EntryProvider
Gets an iterator for the channels, calendars, etc.

Specified by:
getIterator in interface MergedList.EntryProvider

allowGet

public boolean allowGet(String ref)
Description copied from interface: MergedList.EntryProvider
See if we can do a "get" on the calendar, channel, etc.

Specified by:
allowGet in interface MergedList.EntryProvider

getContext

public String getContext(Object obj)
Description copied from interface: MergedList.EntryProvider
Generically access the context of the resource provided by the getIterator() call.

Specified by:
getContext in interface MergedList.EntryProvider
Returns:
The context.

getReference

public String getReference(Object obj)
Description copied from interface: MergedList.EntryProvider
Generically access the reference of the resource provided by the getIterator() call.

Specified by:
getReference in interface MergedList.EntryProvider

getProperties

public ResourceProperties getProperties(Object obj)
Description copied from interface: MergedList.EntryProvider
Generically access the resource's properties.

Specified by:
getProperties in interface MergedList.EntryProvider
Returns:
The resource's properties.

isUserChannel

public boolean isUserChannel(Object channel)
Specified by:
isUserChannel in interface MergedList.EntryProvider

isSpecialSite

public boolean isSpecialSite(Object channel)
Specified by:
isSpecialSite in interface MergedList.EntryProvider

getSiteUserId

public String getSiteUserId(Object channel)
Specified by:
getSiteUserId in interface MergedList.EntryProvider

getSite

public Site getSite(Object channel)
Specified by:
getSite in interface MergedList.EntryProvider