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 | |