Package com.adobe.cq.testing.client

Interface ExperienceFragmentsClient.XFTemplate

All Known Implementing Classes:

ExperienceFragmentsClient.XF_TEMPLATE

Enclosing class:

ExperienceFragmentsClient

public static interface ExperienceFragmentsClient.XFTemplate

Interface with methods that all predefined XF templates from the XF_TEMPLATE must implement

Method Summary

Modifier and Type	Method	Description
<T extends ExperienceFragmentsClient.VariantComponents> T	getComponents(ExperienceFragmentsClient xfClient, String variantPath)	A ExperienceFragmentsClient.VariantComponents subclass object that can be used to configure the components defined in that template
boolean	isSocialTemplate()	This template creates a social variant
String	path()	Path to the template
List<String>	tags()	Template tags
String	variantType()	Template's cq:xfVariantType value

Method Details

path

String path()

Path to the template

Returns:

the path to the template

getComponents

<T extends ExperienceFragmentsClient.VariantComponents>
T getComponents(ExperienceFragmentsClient xfClient,
 String variantPath)

A ExperienceFragmentsClient.VariantComponents subclass object that can be used to configure the components defined in that template

Type Parameters:

T - The subclass of ExperienceFragmentsClient.VariantComponents to which the result should be casted to

Parameters:

xfClient - a ExperienceFragmentsClient instance

variantPath - the path to the experience fragment variant defined with this template

Returns:

A ExperienceFragmentsClient.VariantComponents subclass object that can be used to configure the components defined in that template

isSocialTemplate

boolean isSocialTemplate()

This template creates a social variant

Returns:

true if the template creates a social variant

tags

List<String> tags()

Template tags

Returns:

the list of tags

variantType

String variantType()

Template's cq:xfVariantType value

Returns:

the variant type