com.redhat.rhn.frontend.struts

Class BaseListAction

java.lang.Object

org.apache.struts.action.Action

com.redhat.rhn.frontend.struts.RhnAction

com.redhat.rhn.frontend.struts.RhnListAction

com.redhat.rhn.frontend.struts.BaseListAction

Direct Known Subclasses:

BasePackageListAction, BaseSetListAction, ChannelSystemsAction, CompareChannelAction, CompareCopyAction, CompareFileAction, CompareRevisionAction, ConfigConfirmAction, DiffFilesAction, DiffSystemsAction, FileListConfirmSetupAction, GlobalConfigFileList, GlobalRevisionDeployConfirmSetup, LocalConfigFileList, SummaryAction, SystemChannelsAction, UnsubscribeConfirmAction

public abstract class BaseListAction
extends RhnListAction

BaseListAction - basic base class you can extend to provide functionality for generating a list with support for precondition checking, and setup for building the pageList attribute on the Request. Meant for lists without RhnSet selections.

Field Summary

Fields inherited from class com.redhat.rhn.frontend.struts.RhnAction

SUBMITTED

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
BaseListAction()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	checkPreConditions(RequestContext rctx) Override if you want to check a precondition before executing this Action.
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected abstract DataResult	getDataResult(RequestContext rctx, PageControl pc) Returns the list data used by the list
protected PageControl	getNewPageControl(RequestContext rctx) Method to get a new instance of a page control.
protected void	processForm(RequestContext ctxt, org.apache.struts.action.ActionForm form) Process a form.
protected void	processPageControl(PageControl pc) Extension point to allow controlling the pagination such as turning on filtering, alphabar, etc.
protected void	processRequestAttributes(RequestContext rctx) Add attributes to the request.

Methods inherited from class com.redhat.rhn.frontend.struts.RhnListAction

clampListBounds, trackSet

Methods inherited from class com.redhat.rhn.frontend.struts.RhnAction

addGlobalMessage, addGlobalMessage, addMessage, createErrorMessage, createErrorMessageWithMultipleArgs, createLabelValueList, createMessage, createSuccessMessage, getStrutsDelegate, isSubmitted, l10n, localize, lv, lve, lvel10n, lvl10n, makeParamMap, saveMessages

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseListAction

public BaseListAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm formIn,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)

Overrides:

execute in class org.apache.struts.action.Action

getNewPageControl

protected PageControl getNewPageControl(RequestContext rctx)

Method to get a new instance of a page control.

Parameters:

rctx - RequestContext for this request

Returns:

a PageControl if one is necessary

processPageControl

protected void processPageControl(PageControl pc)

Extension point to allow controlling the pagination such as turning on filtering, alphabar, etc. Does nothing by default.

Parameters:

pc - PageControl

processRequestAttributes

protected void processRequestAttributes(RequestContext rctx)

Add attributes to the request. Does nothing by default

Parameters:

rctx - the context of the current request

checkPreConditions

protected java.lang.String checkPreConditions(RequestContext rctx)

Override if you want to check a precondition before executing this Action. If the precondition fails and returns a NON-NULL return value this will be used as a Resource key for an error message will forward the request to the "error" ActionForward.

Parameters:

rctx - the context of the current request

Returns:

String key for an error message.

getDataResult

protected abstract DataResult getDataResult(RequestContext rctx,
                                            PageControl pc)

Returns the list data used by the list

Parameters:

rctx - Currently active RequestContext.

pc - boundary values

Returns:

List of things bounded by the values of the PageControl.

processForm

protected void processForm(RequestContext ctxt,
                           org.apache.struts.action.ActionForm form)

Process a form. Used for adding datepickers on confirm pages (for example). By default, do nothing.

Parameters:

ctxt - The request context

form - struts ActionForm