com.adobe.cq.social.enablement.site.api

Interface EnablementSiteCatalog

All Superinterfaces:

SocialCollectionComponent, SocialComponent

public interface EnablementSiteCatalog
extends SocialCollectionComponent

SocialCollectionComponent representing a catalog of Enablement resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOURCE_TYPE Resource type of component.

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAllCatalogTags() Returns a map of id/display-name pairs of all catalog tags, only if 'tag' filter is not specified in the requestInfo (or if tag filter is 'all-tags').
PageInfo	getPageInfo() Gets information about the pages for this collection.

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

getItems, getTotalSize, setPagination, setSortedOrder

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

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

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

Resource type of component.

See Also:

Constant Field Values

Method Detail

getPageInfo

PageInfo getPageInfo()

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Returns:

information about the pagination system

getAllCatalogTags

java.util.Map<java.lang.String,java.lang.String> getAllCatalogTags()

Returns a map of id/display-name pairs of all catalog tags, only if 'tag' filter is not specified in the requestInfo (or if tag filter is 'all-tags'). Otherwise, it will return an empty map.

Returns:

Map of of tag id/display-name name/value pairs