class: BaseListRetrieverRequestBean

public abstract class: BaseListRetrieverRequestBean
Author: Markus Haarlaender (initial creation)
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 2360 $ $LastChangedDate: 2009-03-12 15:; Complexity: 1
Dates: Created: 16.07.2009 15:32:03; Modified: 16.07.2009 15:32:03;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {A8CA2FDC-F0DD-4825-BDD2-4AD01524ADFB}
This class is an abstract class for all pages that need to implement and display a paginated list. It requires a suitable BasePaginatorListSessionBean for the same element and filter type. Implementations of this bean must be managed with scope "request" and have to be initialized before any properties of the corresponding BasePaginatorListSessionBean are requested (e.g. by calling the dummy method getBeanName() first). When using own properties in implementing classes which should be passed within a GET request, please ensure to add them to the parameterMap of the corresponding PaginatorListBean and then call redirect() on it.
@param <ListElementType> The Type of the list elements managed by this bean
@param <FilterType> The type of filters managed by this bean
 

Goto: Custom Properties, Fields, Methods

Extends: BreadcrumbPage

See also: CartItemsRetrieverRequestBean, BreadcrumbPage, MyItemsRetrieverRequestBean, RevisionsRetrieverRequestBean, SearchRetrieverRequestBean

Appears in: common_presentation

Connections
 
Custom Properties
 
BaseListRetrieverRequestBean Attributes
Attribute Details
private BasePaginatorListSessionBean
  basePaginatorListSessionBean
 
BaseListRetrieverRequestBean Methods
Operation Details
public
BaseListRetrieverRequestBean(
   BasePaginatorListSessionBean plb,
   boolean refreshAlways):
Sequential
Notes: This super constructor must be called by any implementation of this class. It automatically sets the implementing class as retriever in the corresponding PaginatorListBean and manages the update of the lists and the retrieval of GET-parameters in the right phase of the JSF lifecycle.
public
getBasePaginatorListSessionBean():BasePaginatorListSessionBean
Sequential
Notes: Returns the corresponding BasePaginatorListSessionBean
@return basePaginatorListSessionBean
public abstract
getListPageName():String
Sequential
Notes: Must return the relative name (and evtl. path) of the corresponding jsp page in order to redirect to this page
@return
public abstract
getTotalNumberOfRecords():int
Sequential
Notes: Must return the total size of the retrieved list without limit and offset parameters. E.g. for a search the whole number of search records
@return The whole number of elements in the list, regardless of limit and offset parameters
public abstract
getType():String
Sequential
Notes: This method must return a string that indicates the type of the page. e.g. 'DepositorWS' or 'SearchResult'. It can be used in the jsf views (by calling getListType of the corresponding PaginatorListBean) in order to distinguish between the same list type, filled by different retrievers.
@return A short string that describes the type of the page.
public abstract
init():void
Sequential
Notes: Within this method, implementing subclasses can initialize required objects and values or call initialization methods;
public abstract
readOutParameters():void
Sequential
Notes: When this method is called, the implementations of this bean must read out required parameters from the get request that are needed to retrieve the list. Please use the parameterMap of the corresponding PaginatorListBean to add or update GET-parameters.
public abstract
retrieveList(
   int offset,
   int limit,
   FilterType additionalFilters):List
Sequential
Notes: Whenever this method is called, an updated list with elements of type ListelementType has to be returned
@return
public
setBasePaginatorListSessionBean(
   BasePaginatorListSessionBean basePaginatorListSessionBean):void
Sequential
Notes: Sets the corresponding BasePaginatorListSessionBean
@return basePaginatorListSessionBean