Package com.adobe.cq.cif.common.associatedcontent

Interface AssociatedContentService

@ProviderType
public interface AssociatedContentService

This services provides access to content associated with products an categories. It uses queries, optimised for the product's out-of-the-box indexes to retrieve them.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AssociatedContentService.AssetParams	Defines the parameters used to query Assets (except ContentFragments) as associated content.
static class	AssociatedContentService.CfParams	Defines the parameters used to query ContentFragments as associated content.
static class	AssociatedContentService.PageParams	Defines the parameters used to query Pages as associated content.
static class	AssociatedContentService.XfParams	Defines the parameters used to query experience fragments as associated content.

Method Summary

Modifier and Type	Method	Description
AssociatedContentQuery<com.adobe.cq.dam.cfm.ContentFragment>	listCategoryContentFragments(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.CfParams params)	Returns an AssociatedContentQuery to query for all ContentFragments, that are associated to the category with the given identifier.
AssociatedContentQuery<com.day.cq.wcm.api.Page>	listCategoryContentPages(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.PageParams params)	Returns an AssociatedContentQuery to query for all Pages, that are associated to the category with the given identifier.
AssociatedContentQuery<com.day.cq.wcm.api.Page>	listCategoryExperienceFragments(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.XfParams params)	Returns an AssociatedContentQuery to query for all Experience Fragments, that are associated to the category with the given identifier.
AssociatedContentQuery<com.day.cq.dam.api.Asset>	listProductAssets(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.AssetParams params)	Returns an AssociatedContentQuery to query for all Assets (excl.
AssociatedContentQuery<com.adobe.cq.dam.cfm.ContentFragment>	listProductContentFragments(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.CfParams params)	Returns an AssociatedContentQuery to query for all ContentFragments, that are associated to the product with the given identifier.
AssociatedContentQuery<com.day.cq.wcm.api.Page>	listProductContentPages(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.PageParams params)	Returns an AssociatedContentQuery to query for all Pages, that are associated to the product with the given identifier.
AssociatedContentQuery<com.day.cq.wcm.api.Page>	listProductExperienceFragments(org.apache.sling.api.resource.ResourceResolver rr, AssociatedContentService.XfParams params)	Returns an AssociatedContentQuery to query for all Experience Fragments, that are associated to the product with the given identifier.

Method Detail

listProductAssets

AssociatedContentQuery<com.day.cq.dam.api.Asset> listProductAssets(org.apache.sling.api.resource.ResourceResolver rr,
                                                                   AssociatedContentService.AssetParams params)

Returns an AssociatedContentQuery to query for all Assets (excl. ContentFragments), that are associated to the product with the given identifier.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery

listProductExperienceFragments

AssociatedContentQuery<com.day.cq.wcm.api.Page> listProductExperienceFragments(org.apache.sling.api.resource.ResourceResolver rr,
                                                                               AssociatedContentService.XfParams params)

Returns an AssociatedContentQuery to query for all Experience Fragments, that are associated to the product with the given identifier.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery

listCategoryExperienceFragments

AssociatedContentQuery<com.day.cq.wcm.api.Page> listCategoryExperienceFragments(org.apache.sling.api.resource.ResourceResolver rr,
                                                                                AssociatedContentService.XfParams params)

Returns an AssociatedContentQuery to query for all Experience Fragments, that are associated to the category with the given identifier.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery

listProductContentFragments

AssociatedContentQuery<com.adobe.cq.dam.cfm.ContentFragment> listProductContentFragments(org.apache.sling.api.resource.ResourceResolver rr,
                                                                                         AssociatedContentService.CfParams params)

Returns an AssociatedContentQuery to query for all ContentFragments, that are associated to the product with the given identifier. The both CfParams.model and CfParams.property should be provided to have effect, they are ignored otherwise.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery

listCategoryContentFragments

AssociatedContentQuery<com.adobe.cq.dam.cfm.ContentFragment> listCategoryContentFragments(org.apache.sling.api.resource.ResourceResolver rr,
                                                                                          AssociatedContentService.CfParams params)

Returns an AssociatedContentQuery to query for all ContentFragments, that are associated to the category with the given identifier. The both CfParams.model and CfParams.property should be provided to have effect, they are ignored otherwise.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery

listProductContentPages

AssociatedContentQuery<com.day.cq.wcm.api.Page> listProductContentPages(org.apache.sling.api.resource.ResourceResolver rr,
                                                                        AssociatedContentService.PageParams params)

Returns an AssociatedContentQuery to query for all Pages, that are associated to the product with the given identifier.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery

listCategoryContentPages

AssociatedContentQuery<com.day.cq.wcm.api.Page> listCategoryContentPages(org.apache.sling.api.resource.ResourceResolver rr,
                                                                         AssociatedContentService.PageParams params)

Returns an AssociatedContentQuery to query for all Pages, that are associated to the category with the given identifier.

Parameters:

rr - the ResourceResolver to use for querying

params - search parameters

Returns:

a prepared AssociatedContentQuery