com.redhat.rhn.frontend.action.common

Class BaseSetOperateOnDiffAction

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

Direct Known Subclasses:

BaseKickstartListSubmitAction

public abstract class BaseSetOperateOnDiffAction
extends RhnSetAction

BaseSetOperateOnDiffAction - extension of RhnSetAction that provides a framework for performing specified business operations 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, 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
BaseSetOperateOnDiffAction()

Method Summary

Modifier and Type	Method and Description
protected void	generateUserMessage(java.util.List<RhnSetElement> added, java.util.List<RhnSetElement> removed, javax.servlet.http.HttpServletRequest request)
protected abstract <T extends Identifiable> java.util.Iterator<T>	getCurrentItemsIterator(RequestContext ctx) Get the Iterator for a Collection of Objects that implement the Identifiable interface.
protected java.util.List<java.lang.Long>	getPrimaryElementIds(java.util.List<RhnSetElement> elements)
abstract RhnSetDecl	getSetDecl() Get the RhnSet 'Decl' for the action
protected abstract void	operateOnAddedElements(java.util.List<RhnSetElement> elements, javax.servlet.http.HttpServletRequest request) Operate on the added elements, whatever that entails for a given subclass.
org.apache.struts.action.ActionForward	operateOnDiff(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 items that have removed or added from the set.
protected abstract void	operateOnRemovedElements(java.util.List<RhnSetElement> elements, javax.servlet.http.HttpServletRequest request) Operate on the removed elements, whatever that entails for a given subclass.

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

getDataResult, getKeyMethodMap, 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

BaseSetOperateOnDiffAction

public BaseSetOperateOnDiffAction()

Method Detail

operateOnDiff

public org.apache.struts.action.ActionForward operateOnDiff(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 items that have removed or added from the set. Forwards to the "default" NOTE: Inheriting classes must either define two StringResources, or override the generateUserMessage method. The StringResources must be of the form: getSetName() + ".removed" getSetName() + ".added" To provide messages to the UI that would say: "2 Activation Key(s) added." "1 Activation Key(s) removed." If a different message format is required, just override generateUserMessage

Parameters:

mapping - ActionMapping

formIn - ActionForm

request - ServletRequest

response - ServletResponse

Returns:

The ActionForward to go to next.

generateUserMessage

protected void generateUserMessage(java.util.List<RhnSetElement> added,
                                   java.util.List<RhnSetElement> removed,
                                   javax.servlet.http.HttpServletRequest request)

operateOnRemovedElements

protected abstract void operateOnRemovedElements(java.util.List<RhnSetElement> elements,
                                                 javax.servlet.http.HttpServletRequest request)

Operate on the removed elements, whatever that entails for a given subclass. This method is called immediately before operateOnAddedElements.

Parameters:

elements - The elements which were removed

request - The request

operateOnAddedElements

protected abstract void operateOnAddedElements(java.util.List<RhnSetElement> elements,
                                               javax.servlet.http.HttpServletRequest request)

Operate on the added elements, whatever that entails for a given subclass. This method is called immediately after operateOnRemovedElements.

Parameters:

elements - The elements which were added

request - The request

getSetDecl

public abstract RhnSetDecl getSetDecl()

Get the RhnSet 'Decl' for the action

Specified by:

getSetDecl in class RhnSetAction

Returns:

The set decleration

getCurrentItemsIterator

protected abstract <T extends Identifiable> java.util.Iterator<T> getCurrentItemsIterator(RequestContext ctx)

Get the Iterator for a Collection of Objects that implement the Identifiable interface. This is required so this base class can calculate the original set of items that are associated with the main object we are operating on. This iterator is then 'diffed' against the items in the RhnSet to determine what should be added vs removed.

Type Parameters:

T - The iterator operates on Identifiable types

Parameters:

ctx - to fetch info from

Returns:

Iterator containing Identifiable objects.

getPrimaryElementIds

protected java.util.List<java.lang.Long> getPrimaryElementIds(java.util.List<RhnSetElement> elements)