com.atlassian.confluence.api.model.validation

Interface ValidationResult

All Known Subinterfaces:

MergeValidationResult

All Known Implementing Classes:

CoreValidationResult, RestValidationResult, SimpleMergeValidationResult, SimpleValidationResult

@ExperimentalApi
public interface ValidationResult

Stores the results after an API Service validateX() method is called.

Method Summary

Modifier and Type	Method and Description
Iterable<ValidationError>	getErrors()
boolean	isAuthorized()
boolean	isValid()
ServiceException	throwIfInvalid() converts this validation result into an Exception and throws it
ServiceException	throwIfInvalid(String msg) converts this validation result into an Exception and throws it

Method Detail

isAuthorized

boolean isAuthorized()

Returns:

true if the current user is permitted to perform the execution that the validation is for

isValid

boolean isValid()

Returns:

true if there are no errors in this result

getErrors

Iterable<ValidationError> getErrors()

Returns:

an iterable of the errors stored in this result

throwIfInvalid

ServiceException throwIfInvalid(String msg)
                         throws ServiceException

converts this validation result into an Exception and throws it

Returns:

the exception that will be thrown

Throws:

ServiceException

throwIfInvalid

ServiceException throwIfInvalid()
                         throws ServiceException

converts this validation result into an Exception and throws it

first validation error will be used as message string

Returns:

the exception that will be thrown

All implementations do not conform to specifications and return null. Either the implementation or the javadoc needs to be updated.

Throws:

ServiceException