org.rhq.core.domain.criteria
Class DashboardCriteria

java.lang.Object
  org.rhq.core.domain.criteria.Criteria
      org.rhq.core.domain.criteria.DashboardCriteria

All Implemented Interfaces:

Serializable, BaseCriteria

public class DashboardCriteria
extends Criteria

The criteria for fetching Dashboards.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.rhq.core.domain.criteria.Criteria

Criteria.NonBindingOverrideFilter, Criteria.Restriction, Criteria.Type

Field Summary

Fields inherited from class org.rhq.core.domain.criteria.Criteria

filterOverrides, pageControlOverrides, sortOverrides

Constructor Summary

DashboardCriteria()
Note: Default Criteria Settings:
ownerId = sessionSubject (i.e. the caller)
category = INVENTORY

Method Summary

void	addFilterCategory(DashboardCategory category) If not set explicitly this defaults to DashboardCategory.INVENTORY.
void	addFilterGroupId(Integer filterGroupId)
void	addFilterId(Integer filterId)
void	addFilterName(String filterName)
void	addFilterOwnerId(Integer filterOwnerId) Requires MANAGE_INVENTORY to set.
void	addFilterResourceId(Integer filterResourceId)
void	addFilterShared(Boolean filterShared)
void	addSortName(PageOrdering sortName)
DashboardCategory	getFilterCategory()
Integer	getFilterOwnerId()
Class<Dashboard>	getPersistentClass()
boolean	isInventoryManagerRequired() subclasses should override as necessary

Methods inherited from class org.rhq.core.domain.criteria.Criteria

addRequiredPermissions, addSortField, clearPaging, getAlias, getJPQLFilterOverride, getJPQLSortOverride, getOrderingFieldNames, getPageControlOverrides, getPageNumber, getPageSize, getRequiredPermissions, getRestriction, getSearchExpression, hasCustomizedSorting, isCaseSensitive, isFiltersOptional, isSecurityManagerRequired, isStrict, setCaseSensitive, setFiltersOptional, setPageControl, setPaging, setRestriction, setSearchExpression, setStrict

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardCriteria

public DashboardCriteria()

Note: Default Criteria Settings:
ownerId = sessionSubject (i.e. the caller)
category = INVENTORY

Method Detail

getPersistentClass

public Class<Dashboard> getPersistentClass()

Specified by:

getPersistentClass in class Criteria

addFilterId

public void addFilterId(Integer filterId)

addFilterCategory

public void addFilterCategory(DashboardCategory category)

If not set explicitly this defaults to DashboardCategory.INVENTORY.

Parameters:

category -

getFilterCategory

public DashboardCategory getFilterCategory()

addFilterGroupId

public void addFilterGroupId(Integer filterGroupId)

addFilterName

public void addFilterName(String filterName)

addFilterOwnerId

public void addFilterOwnerId(Integer filterOwnerId)

Requires MANAGE_INVENTORY to set. When not set defaults to dashboards owned by the current user.

Parameters:

filterOwnerId - set to 0 for dashboards owned by anyone

getFilterOwnerId

public Integer getFilterOwnerId()

addFilterResourceId

public void addFilterResourceId(Integer filterResourceId)

addFilterShared

public void addFilterShared(Boolean filterShared)

addSortName

public void addSortName(PageOrdering sortName)

isInventoryManagerRequired

public boolean isInventoryManagerRequired()

Description copied from class: Criteria

subclasses should override as necessary

Overrides:

isInventoryManagerRequired in class Criteria