com.adobe.aemds.guide.common

Class GuideValidationResult

java.lang.Object

com.adobe.aemds.guide.common.GuideValidationResult

public class GuideValidationResult
extends Object

Class representing the result of server side validation performed for an adaptive form. This class provides APIs to access the list of errors in the submitted adaptive form

Since:

AEM 6.1

Constructor Summary

Constructors

Constructor and Description
GuideValidationResult(com.adobe.aemds.guide.utils.GuideSubmitErrorCause errorCausedBy, String errorMessage)
GuideValidationResult(Map<String,String>[] errorList, String excludeFromDorData, com.adobe.aemds.guide.utils.GuideSubmitErrorCause errorCausedBy)

Method Summary

Modifier and Type	Method and Description
ReCaptchaSubmissionData	getCaptchaSubmissionData()
Map<String,String>[]	getErrorList()
String	getExcludeFromDorData()
List<GuideError>	getGuideErrorList() Returns the list of error messages in the server side validation
String	getOriginCode()
String	getOriginMessage()
boolean	hasErrors() Identify if there are any server side validation errors
void	setCaptchaSubmissionData(ReCaptchaSubmissionData reCaptchaSubmissionData)
void	setErrorList(Map<String,String>[] errorList)
void	setErrorMessage(String errorMessage)
void	setExcludeFromDorData(String excludeFromDorData)
void	setGuideErrorList(List<GuideError> guideErrorList) Deprecated. from 6.3 use setGuideErrorList(List guideErrorList, GuideSubmitErrorCause errorCausedBy) instead.
void	setOriginDetails(String originCode, String originDetails)

Constructor Detail

GuideValidationResult

public GuideValidationResult(com.adobe.aemds.guide.utils.GuideSubmitErrorCause errorCausedBy,
                             String errorMessage)

GuideValidationResult

public GuideValidationResult(Map<String,String>[] errorList,
                             String excludeFromDorData,
                             com.adobe.aemds.guide.utils.GuideSubmitErrorCause errorCausedBy)

Method Detail

getGuideErrorList

public List<GuideError> getGuideErrorList()

Returns the list of error messages in the server side validation

Returns:

List of error messages

setGuideErrorList

public void setGuideErrorList(List<GuideError> guideErrorList)

Deprecated. from 6.3 use setGuideErrorList(List guideErrorList, GuideSubmitErrorCause errorCausedBy) instead.

This setter should be used when errors occurred due to server side validation.

getErrorList

public Map<String,String>[] getErrorList()

setErrorList

public void setErrorList(Map<String,String>[] errorList)

getExcludeFromDorData

public String getExcludeFromDorData()

setExcludeFromDorData

public void setExcludeFromDorData(String excludeFromDorData)

setOriginDetails

public void setOriginDetails(String originCode,
                             String originDetails)

setErrorMessage

public void setErrorMessage(String errorMessage)

setCaptchaSubmissionData

public void setCaptchaSubmissionData(ReCaptchaSubmissionData reCaptchaSubmissionData)

getOriginCode

public String getOriginCode()

Returns:

The error code sent by service

getOriginMessage

public String getOriginMessage()

Returns:

The error message sent by service

hasErrors

public boolean hasErrors()

Identify if there are any server side validation errors

Returns:

true if the list contains error, false otherwise.

getCaptchaSubmissionData

public ReCaptchaSubmissionData getCaptchaSubmissionData()