com.redhat.rhn.frontend.struts

Class BaseSetHelper

java.lang.Object

com.redhat.rhn.frontend.struts.BaseSetHelper

Direct Known Subclasses:

RhnListSetHelper, SessionSetHelper

public class BaseSetHelper
extends java.lang.Object

AbstractSetHelper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY
protected javax.servlet.http.HttpServletRequest	request
static java.lang.String	SELECTABLE
static java.lang.String	SELECTED

Constructor Summary

Constructors

Constructor and Description
BaseSetHelper()

Method Summary

Modifier and Type	Method and Description
void	execute(java.util.Set set, java.lang.String listName, java.util.List dataSet) Default struts action one might want to execute when selectAll, unselectAll, update set actions are clicked on a table with an Set.
protected java.util.List	getFilteredList(java.lang.String listName, java.util.List dataSet)
protected boolean	lookupEquals(java.lang.String lookupKey, java.lang.String value)
void	selectAll(java.util.Set set, java.lang.String listName, java.util.List dataSet) Puts all systems visible to the user into the set.
protected void	storeSet(java.util.Set set)
void	syncSelections(java.util.Set set, java.util.List dataSet) Syncs the selections provided by the rhnset to dataset.
void	unselectAll(java.util.Set set, java.lang.String listName, java.util.List dataSet) Clears set for the user.
void	updateSet(java.util.Set set, java.lang.String listName) Updates the set with the items on the current page of the list

Methods inherited from class java.lang.Object

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

Field Detail

request

protected javax.servlet.http.HttpServletRequest request

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

SELECTABLE

public static final java.lang.String SELECTABLE

See Also:

Constant Field Values

SELECTED

public static final java.lang.String SELECTED

See Also:

Constant Field Values

Constructor Detail

BaseSetHelper

public BaseSetHelper()

Method Detail

execute

public void execute(java.util.Set set,
                    java.lang.String listName,
                    java.util.List dataSet)

Default struts action one might want to execute when selectAll, unselectAll, update set actions are clicked on a table with an Set.

Parameters:

set - the set to update

listName - the name of the list to grab the data from

dataSet - the dataset that contains everything in the list

getFilteredList

protected java.util.List getFilteredList(java.lang.String listName,
                                         java.util.List dataSet)

Parameters:

listName - the name of the list

dataSet - the data set

Returns:

the filtered list

lookupEquals

protected boolean lookupEquals(java.lang.String lookupKey,
                               java.lang.String value)

updateSet

public void updateSet(java.util.Set set,
                      java.lang.String listName)

Updates the set with the items on the current page of the list

Parameters:

set - the set to update

listName - the name of the list to grab the data from

unselectAll

public void unselectAll(java.util.Set set,
                        java.lang.String listName,
                        java.util.List dataSet)

Clears set for the user.

Parameters:

set - the set to update

listName - the name of the list to grab the data from

dataSet - the dataSet to deselect

syncSelections

public void syncSelections(java.util.Set set,
                           java.util.List dataSet)

Syncs the selections provided by the rhnset to dataset. This is useful when you want to pre select check boxes

Parameters:

set - this is an Set that holds the selections

dataSet - the dataset that contains everything in the list. Note theitems in the dataset are expected to implement 'com.redhat.rhn.frontend.struts.Selectable'. These are required for use with rhnset.

selectAll

public void selectAll(java.util.Set set,
                      java.lang.String listName,
                      java.util.List dataSet)

Puts all systems visible to the user into the set.

Parameters:

set - the set to update

listName - the name of the list to grab the data from.

dataSet - the dataset that contains everything in the list. Note theitems in the dataset are expected to implement 'com.redhat.rhn.frontend.struts.Selectable'. These are required for use with rhnset.

storeSet

protected void storeSet(java.util.Set set)