com.redhat.rhn.manager

Class BaseManager

java.lang.Object

com.redhat.rhn.manager.BaseManager

Direct Known Subclasses:

ActionManager, ChannelManager, CobblerSnippetLister, ConfigurationManager, CrashManager, DownloadManager, EntitlementManager, ErrataManager, KickstartLister, KickstartManager, MigrationManager, OrgManager, PackageManager, ProfileManager, RepoLister, RhnSetManager, SatManager, ScapManager, SessionManager, SsmOperationManager, SystemManager, UserManager

public abstract class BaseManager
extends java.lang.Object

BaseManager - Class that contains common functionality for our Lister/Manager classes. The most often used method is makeDataResult() that executes a DataSource (our XML sourced SQL query classes) query and formats it into a DataResult object used by our UI layer for viewing.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseManager()

Method Summary

Modifier and Type	Method and Description
protected static DataResult	makeDataResult(java.util.Map queryParams, java.util.Map elabParams, ListControl lc, SelectMode m) Returns a DataResult for the given SelectMode bounded by the values of the ListControl.
protected static <myClass> DataResult<myClass>	makeDataResult(java.util.Map queryParams, java.util.Map elabParams, ListControl lc, SelectMode m, java.lang.Class myClass) Returns a DataResult for the given SelectMode bounded by the values of the ListControl.
protected static DataResult	makeDataResult(java.util.Map queryParams, java.util.Map elabParams, PageControl pc, SelectMode m) Returns a DataResult for the given SelectMode bounded by the values of the PageControl.
protected static <myClass> DataResult<myClass>	makeDataResult(java.util.Map queryParams, java.util.Map elabParams, PageControl pc, SelectMode m, java.lang.Class myClass) Returns a DataResult for the given SelectMode bounded by the values of the PageControl.
protected static DataResult	makeDataResultNoPagination(java.util.Map queryParams, java.util.Map elabParams, SelectMode m) Returns a DataResult for the given SelectMode with no bounds.
protected static <myClass> DataResult<myClass>	makeDataResultNoPagination(java.util.Map queryParams, java.util.Map elabParams, SelectMode m, java.lang.Class myClass) Returns a DataResult for the given SelectMode with no bounds.
protected static DataResult	processListControl(DataResult dr, ListControl lc, java.util.Map elabParams) Process the ListControl against the DataResult.
protected static DataResult	processPageControl(DataResult dr, PageControl pc, java.util.Map elabParams) Process the PageControl against the DataResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseManager

protected BaseManager()

Method Detail

makeDataResult

protected static DataResult makeDataResult(java.util.Map queryParams,
                                           java.util.Map elabParams,
                                           PageControl pc,
                                           SelectMode m)

Returns a DataResult for the given SelectMode bounded by the values of the PageControl.

Parameters:

queryParams - Named parameters for the driving query.

elabParams - Named parameters for the elaboration query.

pc - Page Control boundary definition.

m - datasource SelectMode.

Returns:

resulting DataResult bounded by the values of the PageControl.

makeDataResult

protected static <myClass> DataResult<myClass> makeDataResult(java.util.Map queryParams,
                                                              java.util.Map elabParams,
                                                              PageControl pc,
                                                              SelectMode m,
                                                              java.lang.Class myClass)

Returns a DataResult for the given SelectMode bounded by the values of the PageControl.

Type Parameters:

myClass - the DataResults type

Parameters:

queryParams - Named parameters for the driving query.

elabParams - Named parameters for the elaboration query.

pc - Page Control boundary definition.

m - datasource SelectMode.

myClass - Class of the DataResults

Returns:

resulting DataResult bounded by the values of the PageControl.

makeDataResult

protected static DataResult makeDataResult(java.util.Map queryParams,
                                           java.util.Map elabParams,
                                           ListControl lc,
                                           SelectMode m)

Returns a DataResult for the given SelectMode bounded by the values of the ListControl.

Parameters:

queryParams - Named parameters for the driving query.

elabParams - Named parameters for the elaboration query.

lc - ListControl filtering definition

m - datasource SelectMode.

Returns:

resulting DataResult bounded by the values of the PageControl.

makeDataResult

protected static <myClass> DataResult<myClass> makeDataResult(java.util.Map queryParams,
                                                              java.util.Map elabParams,
                                                              ListControl lc,
                                                              SelectMode m,
                                                              java.lang.Class myClass)

Returns a DataResult for the given SelectMode bounded by the values of the ListControl.

Type Parameters:

myClass - the DataResults type

Parameters:

queryParams - Named parameters for the driving query.

elabParams - Named parameters for the elaboration query.

lc - ListControl filtering definition

m - datasource SelectMode.

myClass - the class of the DataResult to return

Returns:

resulting DataResult bounded by the values of the PageControl.

makeDataResultNoPagination

protected static DataResult makeDataResultNoPagination(java.util.Map queryParams,
                                                       java.util.Map elabParams,
                                                       SelectMode m)

Returns a DataResult for the given SelectMode with no bounds. This can be usefull if you want a list without pagination controls.

Parameters:

queryParams - Named parameters for the driving query.

elabParams - Named parameters for the elaboration query.

m - datasource SelectMode.

Returns:

resulting DataResult bounded by the values of the PageControl.

makeDataResultNoPagination

protected static <myClass> DataResult<myClass> makeDataResultNoPagination(java.util.Map queryParams,
                                                                          java.util.Map elabParams,
                                                                          SelectMode m,
                                                                          java.lang.Class myClass)

Returns a DataResult for the given SelectMode with no bounds. This can be usefull if you want a list without pagination controls.

Type Parameters:

myClass - the DataResults type

Parameters:

queryParams - Named parameters for the driving query.

elabParams - Named parameters for the elaboration query.

m - datasource SelectMode.

myClass - Type of dataresult we will be returning

Returns:

resulting DataResult bounded by the values of the PageControl.

processPageControl

protected static DataResult processPageControl(DataResult dr,
                                               PageControl pc,
                                               java.util.Map elabParams)

Process the PageControl against the DataResult. Returns an unelaborated list if PageControl is null.

Parameters:

dr - the DataResult

elabParams - Named parameters for the elaboration query.

pc - Page Control boundary definition.

Returns:

DataResult modified (filtered) by the PageControl

processListControl

protected static DataResult processListControl(DataResult dr,
                                               ListControl lc,
                                               java.util.Map elabParams)

Process the ListControl against the DataResult. The method does not limit the number of results, unlike PageControl, and simply provides filtering. Returns an unelaborated list if ListControl is null.

Parameters:

dr - the DataResult

elabParams - Named parameters for the elaboration query.

lc - ListControl filtering definition.

Returns:

DataResult modified (filtered) by the PageControl