com.arsdigita.bebop.list
Interface ListModelBuilder

All Superinterfaces:

Lockable

All Known Implementing Classes:

AbstractListModelBuilder, DataQueryListModelBuilder, ProcessListenerListModelBuilder

public interface ListModelBuilder

extends Lockable

Produce a new ListModels for each request. The builder will often run a database query, constructed from request specific information in the state variable passed to makeModel and wrap the result set in a lightweight implementation of ListModel.

The ListModelBuilder is used by the List component whenever it needs to service a request: it calls makeModel on the builder to generate a request-specific ListModel which it then uses for outputting the items in the list.

Warning: The signature of makeModel will be changed to ListModel makeModel(List, PageState) after ACS 4.6

Version:

$Id: //core-platform/dev/src/com/arsdigita/bebop/list/ListModelBuilder.java#8 $

Author:

David Lutterkort

Field Summary

static String

versionId

Method Summary

ListModel

makeModel(List l, PageState state) Produce a ListModel for the request specified by state.

Methods inherited from interface com.arsdigita.util.Lockable

isLocked, lock

Field Detail

versionId

public static final String versionId

See Also:

Constant Field Values

Method Detail

makeModel

public ListModel makeModel(List l,
                           PageState state)

Produce a ListModel for the request specified by state. This method is called at least once, and usually only once, for each request served by the List that this ListModelBuilder has been added to.

Parameters:

state - contains the request specific data for the request

Returns:

the abstract representation of the list item for this request