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 and Description
GuideValidationResult()
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)

Method Summary

Modifier and Type	Method and Description
GuideSubmitErrorCause	getErrorCause()
java.util.List<GuideError>	getGuideErrorList() Returns the list of error messages in the server side validation
JSONObject	getValidationPayload()
boolean	hasErrors() Identify if there are any server side validation errors
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

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 -

GuideValidationResult

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

Parameters:

guideErrorList -

Method Detail

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.

setGuideErrorList

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

This sets List of error and the cause of error

Parameters:

guideErrorList -

errorCausedBy -

getErrorCause

public GuideSubmitErrorCause getErrorCause()

Returns:

The cause of error.

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()