org.sakaiproject.util
Interface MergedList.MergedEntry

All Superinterfaces:

Comparable

Enclosing class:

MergedList

public static interface MergedList.MergedEntry
extends Comparable

channel entry used to communicate with the Velocity templates when dealing with merged channels.

Method Summary

int	compareTo(Object arg0) Implemented so that we can order by the group full name.
String	getDisplayName() Returns the display string for the channel.
String	getReference() Returns the ID of the group.
boolean	isMerged() Returns true if this channel is currently being merged.
boolean	isVisible() This returns true if this list item should be visible to the user.
void	setMerged(boolean b) Marks this channel as being merged or not.

Method Detail

getDisplayName

String getDisplayName()

Returns the display string for the channel.

getReference

String getReference()

Returns the ID of the group. (The ID is used as a key.)

isMerged

boolean isMerged()

Returns true if this channel is currently being merged.

setMerged

void setMerged(boolean b)

Marks this channel as being merged or not.

isVisible

boolean isVisible()

This returns true if this list item should be visible to the user.

compareTo

int compareTo(Object arg0)

Implemented so that we can order by the group full name.

Specified by:

compareTo in interface Comparable