Package com.adobe.aemds.guide.common

Class GuideValidationResult

java.lang.Object

com.adobe.aemds.guide.common.GuideValidationResult

public class GuideValidationResult
extends java.lang.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	Description
GuideValidationResult()
GuideValidationResult(GuideSubmitErrorCause errorCausedBy, int originCode, java.lang.String originMessage)
GuideValidationResult(GuideSubmitErrorCause errorCausedBy, java.lang.String errorMessage)
GuideValidationResult(GuideSubmitErrorCause errorCausedBy, java.lang.String originCode, java.lang.String originMessage)
GuideValidationResult(GuideSubmitErrorCause errorCausedBy, java.lang.String errorMessage, java.util.List<GuideError> guideErrorList)
GuideValidationResult(java.util.List<GuideError> guideErrorList)	Deprecated. from 6.3 use GuideValidationResult(List guideErrorList, GuideSubmitErrorCause errorCausedBy) instead.
GuideValidationResult(java.util.List<GuideError> guideErrorList, GuideSubmitErrorCause errorCausedBy)
GuideValidationResult(java.util.Map<java.lang.String,java.lang.String>[] errorList, java.lang.String excludeFromDorData, GuideSubmitErrorCause errorCausedBy)

Method Summary

Modifier and Type	Method	Description
ReCaptchaSubmissionData	getCaptchaSubmissionData()
GuideSubmitErrorCause	getErrorCause()
GuideSubmitErrorCause	getErrorCausedBy()
java.lang.String	getErrorDetail()
java.lang.String	getErrorInstance()
java.util.Map<java.lang.String,java.lang.String>[]	getErrorList()
java.lang.String	getErrorMessage()
java.lang.String	getErrorTitle()
java.lang.String	getExcludeFromDorData()
java.lang.String	getFormDataPostValidation()	Returns the form data post execution of validation
java.util.List<GuideError>	getGuideErrorList()	Returns the list of error messages in the server side validation
java.lang.String	getOriginCode()
java.lang.String	getOriginContentTypeHeader()
java.lang.String	getOriginMessage()
java.util.List<GuideValidationError>	getValidationErrors()
JSONObject	getValidationPayload()
JSONObject	getValidationPayloadV2(int httpStatusCode)
boolean	hasErrors()	Identify if there are any server side validation errors
void	setCaptchaSubmissionData(ReCaptchaSubmissionData reCaptchaSubmissionData)
void	setErrorCausedBy(GuideSubmitErrorCause errorCausedBy)
void	setErrorDetail(java.lang.String errorDetail)
void	setErrorInstance(java.lang.String errorInstance)
void	setErrorList(java.util.Map<java.lang.String,java.lang.String>[] errorList)
void	setErrorMessage(java.lang.String errorMessage)
void	setErrorTitle(java.lang.String errorTitle)
void	setExcludeFromDorData(java.lang.String excludeFromDorData)
void	setFormDataPostValidation(java.lang.String formDataPostValidation)	Setter for form data post execution of validation
void	setGuideErrorList(java.util.List<GuideError> guideErrorList)	Deprecated. from 6.3 use setGuideErrorList(List guideErrorList, GuideSubmitErrorCause errorCausedBy) instead.
void	setGuideErrorList(java.util.List<GuideError> guideErrorList, GuideSubmitErrorCause errorCausedBy)	This sets List of error and the cause of error
void	setOriginCode(java.lang.String originCode)
void	setOriginContentTypeHeader(java.lang.String originContentTypeHeader)
void	setOriginDetails(java.lang.String originCode, java.lang.String originDetails)
void	setOriginMessage(java.lang.String originMessage)
void	setValidationErrors(java.util.List<GuideValidationError> validationErrors)

Methods inherited from class java.lang.Object

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

Constructor Detail

GuideValidationResult

public GuideValidationResult()

GuideValidationResult

public GuideValidationResult(java.util.List<GuideError> guideErrorList)

Deprecated.

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

Parameters:

guideErrorList - : list of Guide errors

GuideValidationResult

public GuideValidationResult(java.util.List<GuideError> guideErrorList,
                             GuideSubmitErrorCause errorCausedBy)

Parameters:

guideErrorList - : list of Guide errors

errorCausedBy - : cause of error

GuideValidationResult

public GuideValidationResult(GuideSubmitErrorCause errorCausedBy,
                             java.lang.String errorMessage)

GuideValidationResult

public GuideValidationResult(GuideSubmitErrorCause errorCausedBy,
                             java.lang.String errorMessage,
                             java.util.List<GuideError> guideErrorList)

Parameters:

guideErrorList - : list of Guide errors

errorCausedBy - : cause of error

errorMessage - : top level error message sent by service. This is not localized.

GuideValidationResult

public GuideValidationResult(GuideSubmitErrorCause errorCausedBy,
                             java.lang.String originCode,
                             java.lang.String originMessage)

Parameters:

errorCausedBy - : cause of error

originCode - : Error code sent by invoked service:String

originMessage - : Error message sent by invoked service

GuideValidationResult

public GuideValidationResult(java.util.Map<java.lang.String,java.lang.String>[] errorList,
                             java.lang.String excludeFromDorData,
                             GuideSubmitErrorCause errorCausedBy)

GuideValidationResult

public GuideValidationResult(GuideSubmitErrorCause errorCausedBy,
                             int originCode,
                             java.lang.String originMessage)

Parameters:

errorCausedBy - : cause of error

originCode - : Error code sent by invoked service: Integer

originMessage - : Error message sent by invoked service

Method Detail

getFormDataPostValidation

public java.lang.String getFormDataPostValidation()

Returns the form data post execution of validation

Returns:

form data

setFormDataPostValidation

public void setFormDataPostValidation(java.lang.String formDataPostValidation)

Setter for form data post execution of validation

Parameters:

formDataPostValidation -

getGuideErrorList

public java.util.List<GuideError> getGuideErrorList()

Returns the list of error messages in the server side validation

Returns:

List of error messages

setGuideErrorList

public void setGuideErrorList(java.util.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 java.util.Map<java.lang.String,java.lang.String>[] getErrorList()

setErrorList

public void setErrorList(java.util.Map<java.lang.String,java.lang.String>[] errorList)

getExcludeFromDorData

public java.lang.String getExcludeFromDorData()

setExcludeFromDorData

public void setExcludeFromDorData(java.lang.String excludeFromDorData)

setOriginDetails

public void setOriginDetails(java.lang.String originCode,
                             java.lang.String originDetails)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

setOriginCode

public void setOriginCode(java.lang.String originCode)

Parameters:

originCode - : error code sent by service

setOriginMessage

public void setOriginMessage(java.lang.String originMessage)

Parameters:

originMessage - : error message sent by service

setGuideErrorList

public void setGuideErrorList(java.util.List<GuideError> guideErrorList,
                              GuideSubmitErrorCause errorCausedBy)

This sets List of error and the cause of error

Parameters:

guideErrorList - : list of Guide errors

errorCausedBy - : cause of error

setCaptchaSubmissionData

public void setCaptchaSubmissionData(ReCaptchaSubmissionData reCaptchaSubmissionData)

getErrorCause

public GuideSubmitErrorCause getErrorCause()

Returns:

cause of error.

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

top level error message not localized.

getOriginCode

public java.lang.String getOriginCode()

Returns:

The error code sent by service

getOriginMessage

public java.lang.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.

getValidationPayload

public JSONObject getValidationPayload()

getValidationPayloadV2

public JSONObject getValidationPayloadV2(int httpStatusCode)

getCaptchaSubmissionData

public ReCaptchaSubmissionData getCaptchaSubmissionData()

getOriginContentTypeHeader

public java.lang.String getOriginContentTypeHeader()

setOriginContentTypeHeader

public void setOriginContentTypeHeader(java.lang.String originContentTypeHeader)

getErrorTitle

public java.lang.String getErrorTitle()

setErrorTitle

public void setErrorTitle(java.lang.String errorTitle)

getErrorDetail

public java.lang.String getErrorDetail()

setErrorDetail

public void setErrorDetail(java.lang.String errorDetail)

getErrorInstance

public java.lang.String getErrorInstance()

setErrorInstance

public void setErrorInstance(java.lang.String errorInstance)

getValidationErrors

public java.util.List<GuideValidationError> getValidationErrors()

setValidationErrors

public void setValidationErrors(java.util.List<GuideValidationError> validationErrors)

getErrorCausedBy

public GuideSubmitErrorCause getErrorCausedBy()

setErrorCausedBy

public void setErrorCausedBy(GuideSubmitErrorCause errorCausedBy)