org.broadleafcommerce.openadmin.server.service.persistence.validation

Class GlobalValidationResult

java.lang.Object

org.broadleafcommerce.openadmin.server.service.persistence.validation.GlobalValidationResult

Direct Known Subclasses:

PropertyValidationResult

public class GlobalValidationResult
extends Object

DTO representing a boolean whether or not it passed validation and String error message. An error message is not required if the result is not an error. This is most suitable for global errors like those from RowLevelSecurityService

Author:

Phillip Verheyden (phillipuniverse)

See Also:

RowLevelSecurityService}, PropertyValidationResult}

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	errorMessages
protected boolean	valid

Constructor Summary

Constructors

Constructor and Description
GlobalValidationResult(boolean valid)
GlobalValidationResult(boolean valid, String errorMessage)

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorMessage(String errorMessageOrKey) Adds an error message to the list of error messages
String	getErrorMessage() Convenience method to return the first message
List<String>	getErrorMessages()
boolean	isNotValid() Opposite of isValid()
boolean	isValid()
void	setErrorMessage(String errorMessage) Deprecated. - use addErrorMessage(String)
void	setErrorMessages(List<String> errorMessages)
void	setValid(boolean valid) Set the validation result for this property

Methods inherited from class java.lang.Object

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

Field Detail

valid

protected boolean valid

errorMessages

protected List<String> errorMessages

Constructor Detail

GlobalValidationResult

public GlobalValidationResult(boolean valid,
                      String errorMessage)

GlobalValidationResult

public GlobalValidationResult(boolean valid)

Method Detail

isValid

public boolean isValid()

Returns:

Whether or not this property passed validation

isNotValid

public boolean isNotValid()

Opposite of isValid()

Returns:

setValid

public void setValid(boolean valid)

Set the validation result for this property

Parameters:

valid -

getErrorMessage

public String getErrorMessage()

Convenience method to return the first message

Returns:

the error message (or key in a message bundle) for the validation failure

setErrorMessage

@Deprecated
public void setErrorMessage(String errorMessage)

Deprecated. - use addErrorMessage(String)

Sets the error message (or key in a message bundle) for the validation failure. If you have some sort of custom error message for the validation failure it should be set here

Parameters:

errorMessage -

addErrorMessage

public void addErrorMessage(String errorMessageOrKey)

Adds an error message to the list of error messages

Parameters:

errorMessageOrKey -

getErrorMessages

public List<String> getErrorMessages()

setErrorMessages

public void setErrorMessages(List<String> errorMessages)