com.adobe.cq.wcm.core.components.models.contentfragment

Interface ContentFragmentList

All Superinterfaces:

ComponentExporter

@ConsumerType
public interface ContentFragmentList
extends ComponentExporter

Defines a Sling model used for the /apps/core/wcm/components/contentfragmentlist component.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PN_ITEMS Name of the property (in JSON export) that provides the content fragment items.
static String	PN_ELEMENT_NAMES Name of the optional resource property that stores the names of the elements to be used.
static String	PN_MAX_ITEMS Name of the optional resource property that sets the query limit for the number of results to return.
static String	PN_MODEL_PATH Path of the model resource.
static String	PN_ORDER_BY Name of the optional resource property that stores the model element the list is sorted by.
static String	PN_PARENT_PATH Name of the optional resource property that stores the parent path of the content fragments.
static String	PN_SORT_ORDER Name of the optional resource property that sets the sort order of the list (ascending / descending).
static String	PN_TAG_NAMES Name of the optional resource property that stores the tag names for filtering the result.

Method Summary

Modifier and Type	Method and Description
default @NotNull String	getExportedType() Returns the type of the resource for which the export is performed.
default @NotNull Collection<DAMContentFragment>	getListItems() Returns a list of content fragments.

Field Detail

JSON_PN_ITEMS

static final String JSON_PN_ITEMS

Name of the property (in JSON export) that provides the content fragment items.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

See Also:

Constant Field Values

PN_ELEMENT_NAMES

static final String PN_ELEMENT_NAMES

Name of the optional resource property that stores the names of the elements to be used.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

See Also:

Constant Field Values

PN_MODEL_PATH

static final String PN_MODEL_PATH

Path of the model resource. Property is required.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

See Also:

Constant Field Values

PN_TAG_NAMES

static final String PN_TAG_NAMES

Name of the optional resource property that stores the tag names for filtering the result.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

See Also:

Constant Field Values

PN_PARENT_PATH

static final String PN_PARENT_PATH

Name of the optional resource property that stores the parent path of the content fragments.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

See Also:

Constant Field Values

PN_MAX_ITEMS

static final String PN_MAX_ITEMS

Name of the optional resource property that sets the query limit for the number of results to return.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.1.0

See Also:

Constant Field Values

PN_ORDER_BY

static final String PN_ORDER_BY

Name of the optional resource property that stores the model element the list is sorted by.

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.2.0

See Also:

Constant Field Values

PN_SORT_ORDER

static final String PN_SORT_ORDER

Name of the optional resource property that sets the sort order of the list (ascending / descending).

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.2.0

See Also:

Constant Field Values

Method Detail

getListItems

@NotNull
default @NotNull Collection<DAMContentFragment> getListItems()

Returns a list of content fragments.

Returns:

the list of content fragments

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0

getExportedType

@NotNull
default @NotNull String getExportedType()

Returns the type of the resource for which the export is performed.

Specified by:

getExportedType in interface ComponentExporter

Returns:

the type of the component

Since:

com.adobe.cq.wcm.core.components.models.contentfragment 1.0.0