com.adobe.aemds.guide.service

Interface GuideModelTransformer

public interface GuideModelTransformer

Class representing the adaptive form model transformer

Method Summary

Modifier and Type	Method and Description
String	getAdaptiveFormTreeJSON(org.apache.sling.api.resource.Resource guideContainer, com.adobe.aemds.guide.utils.JSONCreationOptions options)
String	getDataJson(org.apache.sling.api.resource.Resource guideContainer, com.adobe.aemds.guide.utils.JSONCreationOptions options) Returns the JSON after merging Guide Template with the data XML
String	getGuideMergedJson(String mergedJsonPath) Returns the Guide Merged Json available at mergedJsonPath
Map<String,String>[]	validate(String dataXml, org.apache.sling.api.resource.Resource resource, String serverUrl, String contextPath) Deprecated.
Map<String,String>[]	validate(String dataXml, org.apache.sling.api.resource.Resource resource, String serverUrl, String locale, String contextPath) Deprecated.
Map<String,String>[]	validate(String dataXml, org.apache.sling.api.resource.Resource resource, String serverUrl, String locale, String contextPath, String fileAttachmentMap) Deprecated.
GuideValidationResult	validateData(String dataXml, org.apache.sling.api.resource.Resource resource, String serverUrl, String locale, String contextPath, String fileAttachmentMap) This API performs Server Side validation for an adaptive form
GuideValidationResult	validateForm(ValidationOptions validationOptions) This API performs Server Side and captcha validation for an adaptive form.

Method Detail

validate

@Deprecated
Map<String,String>[] validate(String dataXml,
                                          org.apache.sling.api.resource.Resource resource,
                                          String serverUrl,
                                          String locale,
                                          String contextPath,
                                          String fileAttachmentMap)
                                   throws GuideException

Deprecated.

This API performs Server Side validation for an adaptive form Returns an array of hash map with two keys("som", "errorText")

Parameters:

dataXml - String representing data of Adaptive Form in XML

resource - Resource pointing to the Adaptive Form Container

serverUrl - URL of the Server to be used for conversion of Rest Calls during server side validation

locale - Locale to be used while getting the merged json from the data xml

contextPath - context path of the server

fileAttachmentMap - file attachment map of the file attachments

Returns:

Array of HashMap, Suppose the output is stored in a variable named map, then map[0].get("som") will give the som expression of the field not valid and map[0].get("errorText") gives the error message of the invalid field.

Throws:

GuideException

See Also:

Resource

validate

@Deprecated
Map<String,String>[] validate(String dataXml,
                                          org.apache.sling.api.resource.Resource resource,
                                          String serverUrl,
                                          String locale,
                                          String contextPath)
                                   throws GuideException

Deprecated.

This API performs Server Side validation for an adaptive form Returns an array of hash map with two keys("som", "errorText")

Parameters:

dataXml - String representing data of Adaptive Form in XML

resource - Resource pointing to the Adaptive Form Container

serverUrl - URL of the Server to be used for conversion of Rest Calls during server side validation

locale - Locale to be used while getting the merged json from the data xml

contextPath - context path of the server

Returns:

Array of HashMap, Suppose the output is stored in a variable named map, then map[0].get("som") will give the som expression of the field not valid and map[0].get("errorText") gives the error message of the invalid field.

Throws:

GuideException

See Also:

Resource

validate

@Deprecated
Map<String,String>[] validate(String dataXml,
                                          org.apache.sling.api.resource.Resource resource,
                                          String serverUrl,
                                          String contextPath)
                                   throws GuideException

Deprecated.

This API performs Server Side validation for an adaptive form Returns an array of hash map with two keys("som", "errorText")

Parameters:

dataXml - String representing data of adaptive form in XML

resource - Resource pointing to the adaptive form Container

serverUrl - URL of the Server to be used for conversion of Rest Calls during server side validation

contextPath - context path of the server

Returns:

Array of HashMap, Suppose the output is stored in a variable named map, then map[0].get("som") will give the som expression of the field not valid and map[0].get("errorText") gives the error message of the invalid field.

Throws:

GuideException

See Also:

Resource

validateData

GuideValidationResult validateData(String dataXml,
                                   org.apache.sling.api.resource.Resource resource,
                                   String serverUrl,
                                   String locale,
                                   String contextPath,
                                   String fileAttachmentMap)
                            throws GuideException

This API performs Server Side validation for an adaptive form

Parameters:

dataXml - String representing data of adaptive form in XML

resource - Resource pointing to the adaptive form Container

serverUrl - URL of the Server to be used for conversion of Rest Calls during server side validation

contextPath - context path of the server

fileAttachmentMap - file attachment map of the file attachments

Returns:

Result of server side validation

Throws:

GuideException

See Also:

GuideValidationResult

validateForm

GuideValidationResult validateForm(ValidationOptions validationOptions)
                            throws GuideException

This API performs Server Side and captcha validation for an adaptive form. If a non-empty som expression is provided, the captcha validation is skipped, captcha validation is performed only for form. For example, if one needs to validate a panel, then the corresponding somExpression of panel is set via ValidationOptions.ValidationOptionsBuilder#setSomExpression(String)

Parameters:

validationOptions - ValidationOptions object, options input for validation

Returns:

Result of server side and captcha validation

Throws:

GuideException

See Also:

GuideValidationResult

getAdaptiveFormTreeJSON

String getAdaptiveFormTreeJSON(org.apache.sling.api.resource.Resource guideContainer,
                               com.adobe.aemds.guide.utils.JSONCreationOptions options)
                        throws org.apache.sling.commons.json.JSONException

Throws:

org.apache.sling.commons.json.JSONException

getDataJson

String getDataJson(org.apache.sling.api.resource.Resource guideContainer,
                   com.adobe.aemds.guide.utils.JSONCreationOptions options)
            throws GuideException

Returns the JSON after merging Guide Template with the data XML

Parameters:

guideContainer - Guide Container resource which has to be merged with data XML

options - Options for merging Guide

Returns:

JSON representation of adaptive from after merging with data XML(if present)

Throws:

GuideException

getGuideMergedJson

String getGuideMergedJson(String mergedJsonPath)
                   throws GuideException

Returns the Guide Merged Json available at mergedJsonPath

Parameters:

mergedJsonPath - Path to guidemergedjson data

Returns:

guide merged json

Throws:

GuideException