org.verapdf.pdfa.results

Interface TestAssertion

public interface TestAssertion

A TestAssertion records the result of performing a validation test on a particular document property, or set of properties.

Author:

Carl Wilson

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TestAssertion.Status Enum that indicates the result of a particular test assertion, i.e.

Method Summary

Modifier and Type	Method and Description
List<String>	getErrorArguments()
String	getErrorMessage()
Location	getLocation()
String	getLocationContext()
String	getMessage()
int	getOrdinal()
RuleId	getRuleId()
TestAssertion.Status	getStatus()

Method Detail

getOrdinal

int getOrdinal()

Returns:

the ordinal for the instance

getRuleId

RuleId getRuleId()

Returns:

the String id for the validation.Rule that this assertion refers to

getStatus

TestAssertion.Status getStatus()

Returns:

the TestAssertion.Status that indicates the result of this test assertion

getMessage

String getMessage()

Returns:

any message that accompanies this assertion.

getLocationContext

String getLocationContext()

Returns:

location context.

getErrorMessage

String getErrorMessage()

Returns:

error message.

getLocation

Location getLocation()

Returns:

the Location within the PDF document where this test was asserted.

getErrorArguments

List<String> getErrorArguments()

Returns:

the list of error arguments