com.adobe.cq.social.moderation.dashboard.api

Interface FilterGroup

All Superinterfaces:

SocialComponent

public interface FilterGroup
extends SocialComponent

A FilterGroup actually contains several groups of filters for searching in the moderation dashboard. Each group within is treated as a logical AND with the other groups, but within each group the selected filters are ORed together for the search.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilterGroup.ResourceTypeFilters Inner class for providing access to the resourceType names.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOURCE_TYPE ResourceType for this component.

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
boolean	getHasMultipleSites() Return whether or not more than one site is visible to the current user.
boolean	getHasSites() Return whether or not any sites are visible to the current user.
FilterGroup.ResourceTypeFilters	getResourceTypeFilters() Inner class for providing access to the resourceType names.
java.util.List<java.lang.String>	getSites() Return a list of sites the current user can moderate.

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

ResourceType for this component.

See Also:

Constant Field Values

Method Detail

getResourceTypeFilters

FilterGroup.ResourceTypeFilters getResourceTypeFilters()

Inner class for providing access to the resourceType names.

Returns:

a ResourceTypeFilters object

getSites

java.util.List<java.lang.String> getSites()

Return a list of sites the current user can moderate.

Returns:

a List of site names.

getHasSites

boolean getHasSites()

Return whether or not any sites are visible to the current user.

Returns:

true if there is at least one site visible, false otherwise.

getHasMultipleSites

boolean getHasMultipleSites()

Return whether or not more than one site is visible to the current user.

Returns:

true if there are two or more sites visible, false otherwise.