com.redhat.rhn.frontend.taglibs.list.helper

Class ListSessionSetHelper

java.lang.Object

com.redhat.rhn.frontend.taglibs.list.helper.ListHelper

com.redhat.rhn.frontend.taglibs.list.helper.ListSessionSetHelper

public class ListSessionSetHelper
extends ListHelper

Used in creating web session backed actions that tie into the "new" list tag (i.e. in the http://rhn.redhat.com/tags/list taglib namespace).

If the user selected items need to be more persistant than simply the session, use ListRhnSetHelper instead.

See Also:

ListRhnSetHelper

Field Summary

Fields inherited from class com.redhat.rhn.frontend.taglibs.list.helper.ListHelper

DATA_SET, LIST

Constructor Summary

Constructors

Constructor and Description
ListSessionSetHelper(Listable inp, javax.servlet.http.HttpServletRequest req) Creates a new ListSessionSetHelper that will attempt to generate its own unique name for the set.
ListSessionSetHelper(Listable inp, javax.servlet.http.HttpServletRequest req, java.util.Map params) Creates a new ListSessionSetHelper that will attempt to generate its own unique name for the set combined with the values of the request parameters.
ListSessionSetHelper(Listable inp, javax.servlet.http.HttpServletRequest req, java.util.Map params, java.lang.String declPrefix) Creates a new ListSessionSetHelper that will use the given prefix as the uniqueness indicator for tracking the set data.

Method Summary

Modifier and Type	Method and Description
protected void	add(java.util.Set c) Add elements to a set.
protected void	clear() clear the set
void	destroy() Obliterates the set from Session or Database
void	execute() Setup the appropriate data bindings.
protected void	execute(java.util.List dataSet) Perform the execute step of the helpers basicall handles the selectall updateset etc..
java.util.Collection	getAddedKeys() Returns a list of items that were added to the initial set
java.lang.String	getDecl() gets the declaration associated to this set
protected java.util.Set	getPreSelected()
java.util.Collection	getRemovedKeys() Returns a list of items that were removed from the initial set (basically list of unselected items)
protected java.util.Map	getSelections() returns the selections map.
java.util.Set<java.lang.String>	getSet() Returns the set that was used to store user selected items.
void	ignoreEmptySelection() Asks the helper to ignore reporting errors if no checkbox was selected and the dispatch action was pressed.
boolean	isDispatched()
protected boolean	isParentAnElement()
boolean	isPreSelectAll()
boolean	isWillClearSet()
static java.lang.String	makeSelectionsName(java.lang.String listName) Returns the name of the selections key.
void	preSelect(java.util.Set set)
void	resync(javax.servlet.http.HttpServletRequest request) resync the selected objects in case you have added anything to set after it was executed
void	setPreSelectAll(boolean preSelectAllIn)
void	setWillClearSet(boolean willClearSetIn) If set to true the associated set will be cleared when setting up the page For something like SystemSetManager we don't want this, so set this to false.
protected int	size() return the size of the set
protected void	syncSelections(java.util.List dataSet) sync the selections of rhn or session set to dataset.
protected void	update() Update the set getting data from List, basically perform the RhnListSetHelper.updateSet

Methods inherited from class com.redhat.rhn.frontend.taglibs.list.helper.ListHelper

getContext, getDataSet, getDataSetName, getListable, getListName, getParamMap, getParentUrl, getUniqueName, setDataSetName, setListName, setParamMap, setParentUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

ListSessionSetHelper

public ListSessionSetHelper(Listable inp,
                            javax.servlet.http.HttpServletRequest req,
                            java.util.Map params,
                            java.lang.String declPrefix)

Creates a new ListSessionSetHelper that will use the given prefix as the uniqueness indicator for tracking the set data.

It is important that if the value chosen for the prefix is unique across all actions to prevent a conflict in storing user selected values.

Parameters:

inp - listable

req - the servlet request

params - the parameter map for this request

declPrefix - the declaration prefix needed to make this set declaration unique

ListSessionSetHelper

public ListSessionSetHelper(Listable inp,
                            javax.servlet.http.HttpServletRequest req,
                            java.util.Map params)

Creates a new ListSessionSetHelper that will attempt to generate its own unique name for the set combined with the values of the request parameters.

Using a combination of a standard prefix (determined by the Listable parameter value) and parameters helps to scope this instance for a dynamic page. For instance, if the page is scoped to a particular channel, having the channel ID in this parameter map will allow the user to work with in the same section of two different channels without the selections in each list interfering with each other.

Parameters:

inp - listable

req - the servlet request

params - the parameter map for this request

ListSessionSetHelper

public ListSessionSetHelper(Listable inp,
                            javax.servlet.http.HttpServletRequest req)

Creates a new ListSessionSetHelper that will attempt to generate its own unique name for the set. This call is suitable when there are no request parameters of interest for the page.

Parameters:

inp - listable

req - the servlet request

Method Detail

destroy

public void destroy()

Obliterates the set from Session or Database

getDecl

public java.lang.String getDecl()

gets the declaration associated to this set

Returns:

the appropriate declaration.

getAddedKeys

public java.util.Collection getAddedKeys()

Returns a list of items that were added to the initial set

Returns:

Set of ids of items that were added.

getRemovedKeys

public java.util.Collection getRemovedKeys()

Returns a list of items that were removed from the initial set (basically list of unselected items)

Returns:

Set of ids of items that were removed.

getSet

public java.util.Set<java.lang.String> getSet()

Returns the set that was used to store user selected items. This is the actual set itself; a copy should be made before attempting to manipulate the contents.

Returns:

will not be null

getSelections

protected java.util.Map getSelections()

returns the selections map.

Returns:

selection map

size

protected int size()

return the size of the set

Returns:

set size

syncSelections

protected void syncSelections(java.util.List dataSet)

sync the selections of rhn or session set to dataset.

Parameters:

dataSet - the result set.

update

protected void update()

Update the set getting data from List, basically perform the RhnListSetHelper.updateSet

add

protected void add(java.util.Set c)

Add elements to a set.

Parameters:

c - set to add.

clear

protected void clear()

clear the set

execute

protected void execute(java.util.List dataSet)

Perform the execute step of the helpers basicall handles the selectall updateset etc..

Parameters:

dataSet - the input data set

ignoreEmptySelection

public void ignoreEmptySelection()

Asks the helper to ignore reporting errors if no checkbox was selected and the dispatch action was pressed.

isDispatched

public boolean isDispatched()

Returns:

true if the dispatch action was called by execute.

isParentAnElement

protected boolean isParentAnElement()

execute

public void execute()

Setup the appropriate data bindings.

Overrides:

execute in class ListHelper

resync

public void resync(javax.servlet.http.HttpServletRequest request)

resync the selected objects in case you have added anything to set after it was executed

Parameters:

request - the request

makeSelectionsName

public static java.lang.String makeSelectionsName(java.lang.String listName)

Returns the name of the selections key.

Parameters:

listName - the name of the list i.e. the value specifided in <rl:list name=>

Returns:

name of the selections key

getPreSelected

protected java.util.Set getPreSelected()

Returns:

the initSet

preSelect

public void preSelect(java.util.Set set)

Parameters:

set - the initial set of items to prepopulate

isWillClearSet

public boolean isWillClearSet()

Returns:

the willClearSet

setWillClearSet

public void setWillClearSet(boolean willClearSetIn)

If set to true the associated set will be cleared when setting up the page For something like SystemSetManager we don't want this, so set this to false.

Parameters:

willClearSetIn - the willClearSet to set

isPreSelectAll

public boolean isPreSelectAll()

Returns:

Returns the preSelectAll.

setPreSelectAll

public void setPreSelectAll(boolean preSelectAllIn)

Parameters:

preSelectAllIn - The preSelectAll to set.