info.magnolia.cms.gui.controlx.list
Interface ListModel

All Known Subinterfaces:

SearchableListModel

All Known Implementing Classes:

AbstractListModel, AbstractSearchableListModel, InboxListModel, MultipleSearchListModel, RepositorySearchListModel, VersionListModel

public interface ListModel

Author:

Sameer Charles $Id: ListModel.java 41137 2011-01-06 18:19:25Z gjoseph $

Method Summary

java.lang.String	getGroupBy() get group on field name
java.lang.String	getGroupByOrder() get group by ordering
ListModelIterator	getListModelIterator() Return the list model iterator
java.lang.String	getSortBy() get sort on field name
java.lang.String	getSortByOrder() get sort by ordering
java.util.Iterator	iterator() implement Iterable
void	setGroupBy(java.lang.String name) set group on field name
void	setGroupBy(java.lang.String name, java.lang.String order) set group on field name
void	setSortBy(java.lang.String name) set sort on field name
void	setSortBy(java.lang.String name, java.lang.String order) set sort on field name

Method Detail

iterator

java.util.Iterator iterator()

implement Iterable

Returns:

iterator

getListModelIterator

ListModelIterator getListModelIterator()

Return the list model iterator

Returns:

setSortBy

void setSortBy(java.lang.String name)

set sort on field name

Parameters:

name -

setSortBy

void setSortBy(java.lang.String name,
               java.lang.String order)

set sort on field name

Parameters:

name -

order -

setGroupBy

void setGroupBy(java.lang.String name)

set group on field name

Parameters:

name -

setGroupBy

void setGroupBy(java.lang.String name,
                java.lang.String order)

set group on field name

Parameters:

name -

order -

getSortBy

java.lang.String getSortBy()

get sort on field name

Returns:

String field name

getSortByOrder

java.lang.String getSortByOrder()

get sort by ordering

Returns:

order ('ASCENDING' | 'DESCENDING')

getGroupBy

java.lang.String getGroupBy()

get group on field name

Returns:

String field name

getGroupByOrder

java.lang.String getGroupByOrder()

get group by ordering

Returns:

order ('ASCENDING' | 'DESCENDING')