com.redhat.rhn.frontend.action.common

Class RhnSetAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.apache.struts.actions.LookupDispatchAction

com.redhat.rhn.frontend.struts.RhnLookupDispatchAction

com.redhat.rhn.frontend.struts.RhnListDispatchAction

com.redhat.rhn.frontend.action.common.RhnSetAction

Direct Known Subclasses:

AffectedSystemsAction, BaseSetOperateOnDiffAction, BaseSetOperateOnSelectedItemsAction, BaseSystemListAction, ChannelAction, CompareDeployedSubmitAction, FailedSystemsAction, FileListSubmitAction, ImportFileSubmitAction, InProgressSystemsAction, ManageRevisionSubmit, PackagePushAction, PreservationListDeleteSubmitAction, RhnSetActionTest.TestAction, RhnSetActionTest.TestActionWithData, TargetSystemsSubmitAction, VisibleSystemsListAction

public abstract class RhnSetAction
extends RhnListDispatchAction

RhnSetAction

NOTE: RhnSetAction and RhnAction contain two duplicate methods - getStrutsDelegate() and createSuccessMessage(). If another method is added to these classes that is common to both we need to refactor the common methods into a new class maybe called RhnActionDelegate.

We cannot introduce a common base class because RhnSetAction and RhnAction fall into different inheritance hierarchies.

See Also:

RhnAction

Field Summary

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

SUBMITTED

Fields inherited from class org.apache.struts.actions.LookupDispatchAction

keyMethodMap, localeMap

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

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

servlet

Constructor Summary

Constructors

Constructor and Description
RhnSetAction()

Method Summary

Modifier and Type	Method and Description
protected abstract DataResult	getDataResult(User user, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request)
protected java.util.Map<java.lang.String,java.lang.String>	getKeyMethodMap()
protected abstract RhnSetDecl	getSetDecl() The declaration of the set we are working with, must be one of the constants from RhnSetDecl
protected java.lang.String	getSetName()
org.apache.struts.action.ActionForward	selectall(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Puts all systems visible to the user into the system_list set.
org.apache.struts.action.ActionForward	unselectall(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears system_list set for the user.
org.apache.struts.action.ActionForward	unspecified(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Default action to execute if dispatch parameter is missing or isn't in map
org.apache.struts.action.ActionForward	updatelist(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Updates RhnSet with checked set elements
protected RhnSet	updateSet(javax.servlet.http.HttpServletRequest request) Updates the set with the items on the current page

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

createSuccessMessage, filter, getForwardName, makeParamMap, processMethodKeys, processParamMap

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

getMethodName, getStrutsDelegate, isSubmitted, l10n, lv

Methods inherited from class org.apache.struts.actions.LookupDispatchAction

execute, getLookupMapName

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, dispatchMethod, getMethod, getParameter

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, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

RhnSetAction

public RhnSetAction()

Method Detail

updatelist

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

Updates RhnSet with checked set elements

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

updateSet

protected RhnSet updateSet(javax.servlet.http.HttpServletRequest request)

Updates the set with the items on the current page

Parameters:

request - The request containing items_on_page and items_selected

Returns:

the newly updated set

selectall

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

Puts all systems visible to the user into the system_list set.

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

unselectall

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

Clears system_list set for the user.

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

unspecified

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

Default action to execute if dispatch parameter is missing or isn't in map

Overrides:

unspecified in class RhnListDispatchAction

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

getKeyMethodMap

protected java.util.Map<java.lang.String,java.lang.String> getKeyMethodMap()

Overrides:

getKeyMethodMap in class RhnListDispatchAction

getSetDecl

protected 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

getSetName

protected final java.lang.String getSetName()

getDataResult

protected abstract DataResult getDataResult(User user,
                                            org.apache.struts.action.ActionForm formIn,
                                            javax.servlet.http.HttpServletRequest request)