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
 String getGroupBy()
          get group on field name
 String getGroupByOrder()
          get group by ordering
 ListModelIterator getListModelIterator()
          Return the list model iterator
 String getSortBy()
          get sort on field name
 String getSortByOrder()
          get sort by ordering
 Iterator iterator()
          implement Iterable
 void setGroupBy(String name)
          set group on field name
 void setGroupBy(String name, String order)
          set group on field name
 void setSortBy(String name)
          set sort on field name
 void setSortBy(String name, String order)
          set sort on field name
 

Method Detail

iterator

Iterator iterator()
implement Iterable

Returns:
iterator

getListModelIterator

ListModelIterator getListModelIterator()
Return the list model iterator

Returns:

setSortBy

void setSortBy(String name)
set sort on field name

Parameters:
name -

setSortBy

void setSortBy(String name,
               String order)
set sort on field name

Parameters:
name -
order -

setGroupBy

void setGroupBy(String name)
set group on field name

Parameters:
name -

setGroupBy

void setGroupBy(String name,
                String order)
set group on field name

Parameters:
name -
order -

getSortBy

String getSortBy()
get sort on field name

Returns:
String field name

getSortByOrder

String getSortByOrder()
get sort by ordering

Returns:
order ('ASCENDING' | 'DESCENDING')

getGroupBy

String getGroupBy()
get group on field name

Returns:
String field name

getGroupByOrder

String getGroupByOrder()
get group by ordering

Returns:
order ('ASCENDING' | 'DESCENDING')


Copyright © 2003-2011 Magnolia International Ltd.. All Rights Reserved.