com.redhat.rhn.frontend.action.common

Class BaseSetOperateOnSelectedItemsAction

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

com.redhat.rhn.frontend.action.common.BaseSetOperateOnSelectedItemsAction

Direct Known Subclasses:

BaseCopyFileSubmitAction, ChannelFileDeploySubmit, ChannelFilesImportSubmit, ChannelFilesListSubmit, ChannelListUnsubscribeSubmitAction, ChannelSystemDeploySubmit, ChannelSystemsListSubmit, ConfigListSubmitAction, GlobalRevisionDeploySubmit, PreservationListDeleteAction, SubscribeSubmit, SubscriptionsSubmitAction, SystemEntitlementsSubmitAction, TargetSystemsListSubmit, UnsubscribeSubmitAction

public abstract class BaseSetOperateOnSelectedItemsAction
extends RhnSetAction

BaseSetOperateOnSelectedItemsAction - extension of RhnSetAction that provides a framework for performing a specified business operation on the currently selected items in the list.

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

Method Summary

Modifier and Type	Method and Description
protected void	addToMessage(org.apache.struts.action.ActionMessages msg, java.lang.String methodName, boolean b, long count)
protected void	addToMessage(org.apache.struts.action.ActionMessages msg, java.lang.String methodName, boolean success, java.lang.Object[] args)
protected org.apache.struts.action.ActionMessage	getEmptySelectionMessage()
protected org.apache.struts.action.ActionMessage	getNoScriptMessage()
protected org.apache.struts.action.ActionForward	handleEmptySelection(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request) This method is to be called when the rhnsetis empty i.e no checked boxes were selected...
org.apache.struts.action.ActionForward	handleNoScript(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Raises an error message saying javascript is required to process this page
protected java.lang.Boolean	operateOnElement(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, RhnSetElement elementIn, User userIn) Here we go to the subclass to actually operate on the element
org.apache.struts.action.ActionForward	operateOnSelectedSet(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Execute some operation on the set of selected items.
org.apache.struts.action.ActionForward	operateOnSelectedSet(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm formIn, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String callbackMethodName) Execute some operation on the set of selected items.
protected void	processMessage(org.apache.struts.action.ActionMessages msgs, java.lang.String methodName, long successCount, long failureCount) This basically adds all the action messages that will be used for validation errors or status messages

Methods inherited from class com.redhat.rhn.frontend.action.common.RhnSetAction

getDataResult, getKeyMethodMap, getSetDecl, getSetName, selectall, unselectall, unspecified, updatelist, updateSet

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

BaseSetOperateOnSelectedItemsAction

public BaseSetOperateOnSelectedItemsAction()

Method Detail

operateOnSelectedSet

public org.apache.struts.action.ActionForward operateOnSelectedSet(org.apache.struts.action.ActionMapping mapping,
                                                                   org.apache.struts.action.ActionForm formIn,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response,
                                                                   java.lang.String callbackMethodName)

Execute some operation on the set of selected items. Forwards to the "default" NOTE: Must define StringResource for failure and success messages: getSetName() + ".success" for providing a parameterized getSetName() + ".failure" for providing a parameterized message to the UI that would say "2 ServerProbe Suite(s) deleted."

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

callbackMethodName - Name of the call back method.

Returns:

The ActionForward to go to next.

handleEmptySelection

protected org.apache.struts.action.ActionForward handleEmptySelection(org.apache.struts.action.ActionMapping mapping,
                                                                      org.apache.struts.action.ActionForm formIn,
                                                                      javax.servlet.http.HttpServletRequest request)

This method is to be called when the rhnsetis empty i.e no checked boxes were selected... This method basically sets up the error message and returns the correct action forward.

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

Returns:

The ActionForward to go to next.

getEmptySelectionMessage

protected org.apache.struts.action.ActionMessage getEmptySelectionMessage()

Returns:

default empty selection message

handleNoScript

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

Raises an error message saying javascript is required to process this page

Parameters:

mapping - struts ActionMapping

formIn - struts ActionForm

request - HttpServletRequest

response - HttpServletResponse

Returns:

An action forward to the default page with the error message

getNoScriptMessage

protected org.apache.struts.action.ActionMessage getNoScriptMessage()

Returns:

default no java script message

processMessage

protected void processMessage(org.apache.struts.action.ActionMessages msgs,
                              java.lang.String methodName,
                              long successCount,
                              long failureCount)

This basically adds all the action messages that will be used for validation errors or status messages

Parameters:

msgs - container of the messages

methodName - name of the caller method which is used as a key

successCount - the number of successful actions

failureCount - the number of failures.

addToMessage

protected void addToMessage(org.apache.struts.action.ActionMessages msg,
                            java.lang.String methodName,
                            boolean b,
                            long count)

addToMessage

protected void addToMessage(org.apache.struts.action.ActionMessages msg,
                            java.lang.String methodName,
                            boolean success,
                            java.lang.Object[] args)

operateOnSelectedSet

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

Execute some operation on the set of selected items. Forwards to the "default" NOTE: Must define StringResource for failure and success messages: getSetName() + ".success" for providing a parameterized message to the UI that would say "2 ServerProbe Suite(s) deleted."

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

operateOnElement

protected java.lang.Boolean operateOnElement(org.apache.struts.action.ActionForm form,
                                             javax.servlet.http.HttpServletRequest request,
                                             RhnSetElement elementIn,
                                             User userIn)

Here we go to the subclass to actually operate on the element

Parameters:

form - the ActionForm

request - the HttpServletRequest object

elementIn - we want to fetch the ID from

userIn - who is performing the operation

Returns:

true if element should be operated on