com.adobe.cq.xf

Interface ExperienceFragmentsService

@ProviderType
public interface ExperienceFragmentsService

Service that provides methods to work with the Experience Fragments objects

Method Summary

Modifier and Type	Method and Description
java.util.List<Reference>	findReferences(java.lang.String experienceFragmentPath, java.lang.String... referenceType) Returns a list of references for an experience fragment at a given path
java.util.List<Page>	listPagesUsingVariation(ExperienceFragmentVariation... variation) Finds all the pages that use one or more experience fragment variations
java.util.List<ExperienceFragmentVariation>	listUsedVariations(Page page) Finds all the experience fragments variations in a given content page.

Method Detail

listUsedVariations

java.util.List<ExperienceFragmentVariation> listUsedVariations(Page page)

Finds all the experience fragments variations in a given content page.

Parameters:

page - the content page

Returns:

a list of variations used in the given page

listPagesUsingVariation

java.util.List<Page> listPagesUsingVariation(ExperienceFragmentVariation... variation)

Finds all the pages that use one or more experience fragment variations

Parameters:

variation - one or more ExperienceFragmentVariation objects

Returns:

a list of pages that contain components pointing to those experience fragments variations

findReferences

java.util.List<Reference> findReferences(java.lang.String experienceFragmentPath,
                                         java.lang.String... referenceType)

Returns a list of references for an experience fragment at a given path

Parameters:

experienceFragmentPath - the path to the experience fragment. This path must point to the actual experience fragment page, not the "jcr:content" node.

referenceType - an optional reference type which indicates which reference provider(s) to use. If this parameter is not supplied then all the references are returned

Returns:

a list of Reference object. The "source" of the reference will be the page that uses the experience fragment and the "target" of the reference will be specific variation that the page embeds.