com.redhat.rhn.frontend.struts

Class BaseSetListAction

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

com.redhat.rhn.frontend.struts.BaseSetListAction

Direct Known Subclasses:

BaseCopyConfigFileAction, BaseKickstartListSetupAction, BaseSetListActionTest.TestSetupListAction, ChannelFileDeploySetup, ChannelFilesImportSetup, ChannelFilesListSetup, ChannelListAction, ChannelSystemDeploySetup, ChannelSystemsListSetup, CompareDeployedAction, ConfigListAction, FileListSetupAction, GlobalRevisionDeploySetup, ImportFileAction, ManageRevisionSetup, PreservationListAction, PreservationListConfirmDeleteAction, SubscriptionsSetupAction, TargetSystemsListSetup, UnsubscribeAction

public abstract class BaseSetListAction
extends BaseListAction

BaseSetListAction - extension of BaseListAction that includes necessary logic to provide functionality for displaying an RhnSet.

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
BaseSetListAction()

Method Summary

Modifier and Type	Method and Description
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 java.util.Iterator	getSelectedItemsIterator(RequestContext ctx, org.apache.struts.action.ActionForm form) Extend this method to return an initial pre-selection list So the items returned here will get automatically selected in the rhn set.
abstract RhnSetDecl	getSetDecl() The declaration of the set we are working with, must be one of the constants from RhnSetDecl
protected void	populateNewSet(RequestContext rctx, java.util.Iterator identifiables) Helper method to prePopulate a new set This method is utiliy method NOT intended to be extended It can be used when overriding the 'processRequestAttributes' method A good use case for this method is when are preselecting a list of items from the global list.
protected boolean	preClearSet() Should we clear the RhnSet for this action when beginning a new request? (i.e.
protected void	processForm(RequestContext rctx, org.apache.struts.action.ActionForm form) Process a form.
protected void	processRequestAttributes(RequestContext rctx) Add attributes to the request.

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

checkPreConditions, getDataResult, getNewPageControl, processPageControl

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

BaseSetListAction

public BaseSetListAction()

Method Detail

getSetDecl

public abstract RhnSetDecl getSetDecl()

The declaration of the set we are working with, must be one of the constants from RhnSetDecl

Returns:

the declaration of the set we are working with

processRequestAttributes

protected void processRequestAttributes(RequestContext rctx)

Add attributes to the request. Does nothing by default

Overrides:

processRequestAttributes in class BaseListAction

Parameters:

rctx - the context of the current request

populateNewSet

protected final void populateNewSet(RequestContext rctx,
                                    java.util.Iterator identifiables)

Helper method to prePopulate a new set This method is utiliy method NOT intended to be extended It can be used when overriding the 'processRequestAttributes' method A good use case for this method is when are preselecting a list of items from the global list.

Parameters:

rctx - a request context object

identifiables - A Iterator iterating over items of type "com.redhat.rhn.domain.Identifiable"

processForm

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

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

Overrides:

processForm in class BaseListAction

Parameters:

rctx - The request context

form - struts ActionForm

getSelectedItemsIterator

protected java.util.Iterator getSelectedItemsIterator(RequestContext ctx,
                                                      org.apache.struts.action.ActionForm form)

Extend this method to return an initial pre-selection list So the items returned here will get automatically selected in the rhn set. So when the table renders the items here will be checked.

Parameters:

ctx - the request context

form - the ActionForm

Returns:

A Iterator iterating over items of type "com.redhat.rhn.domain.Identifiable" EMPTY_LIST.iterator() is prefered by default but we should be handling null cases also where we use this.

preClearSet

protected boolean preClearSet()

Should we clear the RhnSet for this action when beginning a new request? (i.e. *NOT* a form submission) Default behavior is to clear the set to prevent stale selections from appearing. Sub-classes can override this method if this is not desired.

Returns:

true to clear the RhnSet when starting a new pageflow, false otherwise.

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 BaseListAction