Package com.adobe.cq.testing.client

Class ExperienceFragmentsClient.ConvertToXFAction

java.lang.Object

com.adobe.cq.testing.client.ExperienceFragmentsClient.ConvertToXFAction

Enclosing class:

ExperienceFragmentsClient

public static class ExperienceFragmentsClient.ConvertToXFAction
extends Object

Convert a component to an Experience Fragment

Constructor Summary

Constructors

Constructor	Description
ConvertToXFAction(ExperienceFragmentsClient client)

Method Summary

Modifier and Type	Method	Description
org.apache.sling.testing.clients.SlingHttpResponse	addToAnExistingXF(String componentPath, String parentXFPath, String variantTitle, ExperienceFragmentsClient.XF_TEMPLATE variantTemplate, List<String> variantTags, int... expectedStatus)	Convert and creating a new Experience Fragment Variant
org.apache.sling.testing.clients.SlingHttpResponse	addToAnExistingXF(String componentPath, String parentXFPath, String variantTitle, String variantTemplate, List<String> variantTags, int... expectedStatus)	Convert and creating a new Experience Fragment Variant
org.apache.sling.testing.clients.SlingHttpResponse	createNewExperienceFragment(String componentPath, String parentPath, String xfTitle, List<String> xfTags, String variantTitle, ExperienceFragmentsClient.XF_TEMPLATE variantTemplate, List<String> variantTags, int... expectedStatus)	Convert by creating a new Experience Fragment
org.apache.sling.testing.clients.SlingHttpResponse	createNewExperienceFragment(String componentPath, String parentPath, String xfTitle, List<String> xfTags, String variantTitle, String variantTemplate, List<String> variantTags, int... expectedStatus)	Convert and create a new Experience Fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConvertToXFAction

public ConvertToXFAction(ExperienceFragmentsClient client)

Method Detail

createNewExperienceFragment

public org.apache.sling.testing.clients.SlingHttpResponse createNewExperienceFragment(String componentPath,
                                                                                      @Nullable
                                                                                      String parentPath,
                                                                                      String xfTitle,
                                                                                      @Nullable
                                                                                      List<String> xfTags,
                                                                                      String variantTitle,
                                                                                      String variantTemplate,
                                                                                      @Nullable
                                                                                      List<String> variantTags,
                                                                                      int... expectedStatus)
                                                                               throws org.apache.sling.testing.clients.ClientException

Convert and create a new Experience Fragment

Parameters:

componentPath - component path

parentPath - Experience Fragment parent path

xfTitle - Experience Fragment title

xfTags - Experience Fragment tags

variantTitle - Experience Fragment Variant title

variantTemplate - Experience Fragment Variant template

variantTags - Experience Fragment Variant tags

expectedStatus - http status expected after sending the convert request

Returns:

The full SlingHttpResponse for the convert request

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

createNewExperienceFragment

public org.apache.sling.testing.clients.SlingHttpResponse createNewExperienceFragment(String componentPath,
                                                                                      String parentPath,
                                                                                      String xfTitle,
                                                                                      List<String> xfTags,
                                                                                      String variantTitle,
                                                                                      ExperienceFragmentsClient.XF_TEMPLATE variantTemplate,
                                                                                      List<String> variantTags,
                                                                                      int... expectedStatus)
                                                                               throws org.apache.sling.testing.clients.ClientException

Convert by creating a new Experience Fragment

Parameters:

componentPath - Experience Fragment component path

parentPath - Experience Fragment parent path

xfTitle - Experience Fragment title

xfTags - Experience Fragment tags

variantTitle - Experience Fragment Variant title

variantTemplate - Experience Fragment Variant template

variantTags - Experience Fragment Variant tags

expectedStatus - http status expected after sending the convert request

Returns:

The full SlingHttpResponse for the convert request

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

addToAnExistingXF

public org.apache.sling.testing.clients.SlingHttpResponse addToAnExistingXF(String componentPath,
                                                                            String parentXFPath,
                                                                            String variantTitle,
                                                                            String variantTemplate,
                                                                            @Nullable
                                                                            List<String> variantTags,
                                                                            int... expectedStatus)
                                                                     throws org.apache.sling.testing.clients.ClientException

Convert and creating a new Experience Fragment Variant

Parameters:

componentPath - path to the component that will converted to a variant

parentXFPath - parent Experience Fragment path

variantTitle - Experience Fragment Variant title

variantTemplate - Experience Fragment Variant template

variantTags - Experience Fragment Variant tags

expectedStatus - http status expected after sending the convert request

Returns:

The full SlingHttpResponse for the convert request

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

addToAnExistingXF

public org.apache.sling.testing.clients.SlingHttpResponse addToAnExistingXF(String componentPath,
                                                                            String parentXFPath,
                                                                            String variantTitle,
                                                                            ExperienceFragmentsClient.XF_TEMPLATE variantTemplate,
                                                                            @Nullable
                                                                            List<String> variantTags,
                                                                            int... expectedStatus)
                                                                     throws org.apache.sling.testing.clients.ClientException

Convert and creating a new Experience Fragment Variant

Parameters:

componentPath - path to the component that will converted to a variant

parentXFPath - parent Experience Fragment path

variantTitle - Experience Fragment Variant title

variantTemplate - Experience Fragment Variant template

variantTags - Experience Fragment Variant tags

expectedStatus - http status expected after sending the convert request

Returns:

The full SlingHttpResponse for the convert request

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails