org.davesag.generica.controller
Interface Lister

All Superinterfaces:
ActionController, Controller

public interface Lister
extends ActionController

An implementation of the Lister interface must be able to geneerate a list of summarised objects for use by a GUI or similar.

Tell the action which Lister to use by specifying both a lister parameter, and a Summariser in the Action's parameter config.
you can also optionally specify list-param 0 .. list-param n indicating context specific information such as sort orders, filters and the like. It is up to the application developer to specify these params. They are specified much like the presentation-params in the Presenter as a ':' delimited tuple.

         <action
                path="/admin/listsitecopy"
                type="org.davesag.generica.servlet.action.ListAction"
                parameter="lister=com.myapp.controller.SiteCopyController;
                                        summariser=com.myapp.controller.SiteCopyController">
                <forward name="success" path="thanks.editsitecopy.page"/>
        </action>
 
Note in the above example both controllers are embodied in the same class.

Since:
Generica 1.0
Version:
CVS Revision $Id: Lister.java,v 1.2 2004/03/30 10:12:56 norm Exp $
Author:
Dave Sag http://www.davesag.com

Method Summary
 List list(Map params, Summariser summary)
          Make a List using the params and Summariser provided for use by GUIs.
 
Methods inherited from interface org.davesag.generica.controller.ActionController
setAction
 
Methods inherited from interface org.davesag.generica.controller.Controller
setForm, setRequest, setResponse
 

Method Detail

list

public List list(Map params,
                 Summariser summary)
          throws Exception
Make a List using the params and Summariser provided for use by GUIs.

If the summary is null then just list the raw objects.

Parameters:
params - Any optional list-params.
summary - How to summarise the objects, or null. If null then list raw objects.
Returns:
The List of summaries (or raw objects).
Throws:
Exception - if something went wrong.


Dave Sag Generica API version 0.5.9 - (prerelease) Copyright 2003 - 2004 Dave Sag.