com.adobe.aemds.guide.model

Class ValidationOptions.ValidationOptionsBuilder

java.lang.Object

com.adobe.aemds.guide.model.ValidationOptions.ValidationOptionsBuilder

Enclosing class:

ValidationOptions

public static class ValidationOptions.ValidationOptionsBuilder
extends Object

Static helper class to build validation options. These validation options defines the basic options required to perform server side validation of an adaptive form

Since:

6.3

Constructor Summary

Constructors

Constructor and Description
ValidationOptionsBuilder()

Method Summary

Modifier and Type	Method and Description
ValidationOptions	build() This will build the ValidationOptions object using the options provided in the setters.
ValidationOptions.ValidationOptionsBuilder	setCaptchaData(String captchaData) Sets the captcha data to validate the captcha.
ValidationOptions.ValidationOptionsBuilder	setContextPath(String contextPath) Sets the context path of the application
ValidationOptions.ValidationOptionsBuilder	setData(String data) Sets the submitted data of the adaptive form.
ValidationOptions.ValidationOptionsBuilder	setFormContainerResource(org.apache.sling.api.resource.Resource formContainerResource) Sets the adaptive form container resource against which server side validation is to be performed
ValidationOptions.ValidationOptionsBuilder	setLocale(String locale) Sets the locale to be used during validation of data on server side
ValidationOptions.ValidationOptionsBuilder	setServerUrl(String serverUrl) Sets the server name to be used for conversion of relative to absolute URL

Constructor Detail

ValidationOptionsBuilder

public ValidationOptionsBuilder()

Method Detail

setFormContainerResource

public ValidationOptions.ValidationOptionsBuilder setFormContainerResource(org.apache.sling.api.resource.Resource formContainerResource)

Sets the adaptive form container resource against which server side validation is to be performed

Parameters:

formContainerResource - adaptive form container resource against which validation would be performed.

Returns:

ValidationOptions.ValidationOptionsBuilder validation options builder

setData

public ValidationOptions.ValidationOptionsBuilder setData(String data)

Sets the submitted data of the adaptive form.

Parameters:

data - String representing data of Adaptive form.

Returns:

ValidationOptions.ValidationOptionsBuilder validation options builder

setCaptchaData

public ValidationOptions.ValidationOptionsBuilder setCaptchaData(String captchaData)

Sets the captcha data to validate the captcha. This is optional and would depend on the existence of captcha component in an adaptive form.

Parameters:

captchaData - Captcha data coming from request to validate captcha, which resides in the form.

Returns:

ValidationOptions.ValidationOptionsBuilder validation options builder

setServerUrl

public ValidationOptions.ValidationOptionsBuilder setServerUrl(String serverUrl)

Sets the server name to be used for conversion of relative to absolute URL

Parameters:

serverUrl - host name/ip to be used for conversion of relative URL to absolute URL during server side validation.

Returns:

ValidationOptions.ValidationOptionsBuilder validation options builder

setContextPath

public ValidationOptions.ValidationOptionsBuilder setContextPath(String contextPath)

Sets the context path of the application

Parameters:

contextPath - Context path for the application.

Returns:

ValidationOptions.ValidationOptionsBuilder validation options builder

setLocale

public ValidationOptions.ValidationOptionsBuilder setLocale(String locale)

Sets the locale to be used during validation of data on server side

Parameters:

locale - locale

Returns:

ValidationOptions.ValidationOptionsBuilder validation options builder

build

public ValidationOptions build()

This will build the ValidationOptions object using the options provided in the setters.

Returns:

ValidationOptions validation options