Package de.espirit.firstspirit.agency

Interface ElementValidationReport

All Superinterfaces:

Serializable

public interface ElementValidationReport
extends Serializable

Combined validation report on an element.

Since:

5.0.100

Method Summary

Modifier and Type	Method	Description
@NotNull IDProvider	getElement()	Deprecated. since 5.0.311, use getElement(SpecialistsBroker) instead.
@NotNull IDProvider	getElement(SpecialistsBroker broker)	Get the element this report is generated for.
@Nullable MultiFormValidationReport	getReport(ValidationAgent.ValidationScope scope)	Get the report for a given scope.
boolean	isValid()	Indicates the validated element to be valid and no reports being generated.

Method Details

isValid

boolean isValid()

Indicates the validated element to be valid and no reports being generated.

Returns:

true, if valid.

Since:

5.0.100

getElement

@Deprecated
@NotNull
@NotNull IDProvider getElement()
                        throws UnsupportedOperationException

Deprecated.

since 5.0.311, use getElement(SpecialistsBroker) instead.

Get the element this report is generated for.

Note: might throw UnsupportedOperationException, if used in a remote environment.

Returns:

The validated element.

Throws:

UnsupportedOperationException - if used in a remote environment.

Since:

5.0.100

getElement

@NotNull
@NotNull IDProvider getElement(SpecialistsBroker broker)
                        throws NoSuchElementException

Get the element this report is generated for.

Parameters:

broker - A broker to resolve the element.

Returns:

The requested element.

Throws:

NoSuchElementException - if the referenced element does not exist.

Since:

5.0.31

getReport

@Nullable
@Nullable MultiFormValidationReport getReport(ValidationAgent.ValidationScope scope)

Get the report for a given scope.

Parameters:

scope - The scope to get reports for.

Returns:

The according scope-related report or null, if no report is available for the given scope.

Since:

5.0.8