com.atlassian.confluence.rest.api.model.validation

Class RestValidationResult

java.lang.Object

com.atlassian.confluence.rest.api.model.validation.RestValidationResult

All Implemented Interfaces:

ValidationResult

@ExperimentalApi
public class RestValidationResult
extends Object
implements ValidationResult

REST-friendly version of a ValidationResult.

Since:

5.6

Constructor Summary

Constructors

Constructor and Description
RestValidationResult(ValidationResult that)

Method Summary

Modifier and Type	Method and Description
Iterable<ValidationError>	getErrors() Returns an iterable of the errors (if any) stored in this result.
boolean	isAllowedInReadOnlyMode() Checks for allowedInReadOnlyMode status.
boolean	isAuthorized() Checks for authorization status.
boolean	isValid() Checks for validity.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.api.model.validation.ValidationResult

convertToServiceException, isNotSuccessful, isSuccessful, throwIfInvalid, throwIfInvalid, throwIfNotSuccessful, throwIfNotSuccessful, throwIfNotValid

Constructor Detail

RestValidationResult

public RestValidationResult(ValidationResult that)

Method Detail

isAuthorized

public boolean isAuthorized()

Description copied from interface: ValidationResult

Checks for authorization status. Does NOT imply the validity check.

Specified by:

isAuthorized in interface ValidationResult

Returns:

true if the current user is permitted to perform the execution that the validation is for, false otherwise.

See Also:

ValidationResult.isValid(), ValidationResult.isSuccessful()

isAllowedInReadOnlyMode

public boolean isAllowedInReadOnlyMode()

Description copied from interface: ValidationResult

Checks for allowedInReadOnlyMode status. Does NOT imply the validity check.

Specified by:

isAllowedInReadOnlyMode in interface ValidationResult

Returns:

true if the current user is allowed to perform the execution in read-only mode that the validation is for, false otherwise.

See Also:

ValidationResult.isValid(), ValidationResult.isSuccessful()

isValid

public boolean isValid()

Description copied from interface: ValidationResult

Checks for validity. Does NOT imply the authorization check.

By contract implementations MUST return false if there are errors in this ValidationResult. Default implementation is usually enough.

Specified by:

isValid in interface ValidationResult

Returns:

true if there are no errors in this result, false otherwise.

See Also:

ValidationResult.getErrors(), ValidationResult.isAuthorized(), ValidationResult.isSuccessful()

getErrors

public Iterable<ValidationError> getErrors()

Description copied from interface: ValidationResult

Returns an iterable of the errors (if any) stored in this result. By contract having any errors here MUST also result in ValidationResult.isValid() returning false.

Default implementation of ValidationResult.isValid() is safe for null values. Be cautious about returning null if not using the default implementation for ValidationResult.isValid().

Specified by:

getErrors in interface ValidationResult

Returns:

an iterable of the errors stored in this result.

See Also:

ValidationResult.isValid(), ValidationError

toString

public String toString()

Overrides:

toString in class Object