com.exlibris.dps.sdk.techmd

Interface FormatValidationPlugin

public interface FormatValidationPlugin

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgent() Returns the software agent key compatible with the application key in the application library.
default java.util.List<java.lang.String>	getErrorIds() Optional: the error IDs of the errors that occurred, if occurred, during the validation.
java.util.List<java.lang.String>	getErrors() A list of errors that occurred, if occurred, during the validation.
default java.lang.String	getProfile() Optional: the validation profile used during the format validation.
default java.lang.String	getValidationDetails() Returns further details regarding the format validation when the isValidate and isWellFormed are not sufficient to record the validation results.
boolean	isValid() A true/false indicator if the file's format is valid.
boolean	isWellFormed() A true/false indicator if the file is well formed.
boolean	validateFormat(java.lang.String filepath) Performs a format validation check on a file

Method Detail

validateFormat

boolean validateFormat(java.lang.String filepath)

Performs a format validation check on a file

Parameters:

filepath -

Returns:

false if failed, true if not

getAgent

java.lang.String getAgent()

Returns the software agent key compatible with the application key in the application library.

Returns:

the application key.

isValid

boolean isValid()

A true/false indicator if the file's format is valid. If there is no specific implementation, return true.

Returns:

validation result if implemented, otherwise true.

isWellFormed

boolean isWellFormed()

A true/false indicator if the file is well formed. If there is no specific implementation, return true.

Returns:

file formed result if implemented, otherwise true.

getErrors

java.util.List<java.lang.String> getErrors()

A list of errors that occurred, if occurred, during the validation.

Returns:

list of error messages

getErrorIds

default java.util.List<java.lang.String> getErrorIds()

Optional: the error IDs of the errors that occurred, if occurred, during the validation.

Returns:

list of error IDs corresponding to the error messages

getProfile

default java.lang.String getProfile()

Optional: the validation profile used during the format validation. This depends on the plug-in implementation and tools used. e.g. veraPDF.

Returns:

the validation profile used

getValidationDetails

default java.lang.String getValidationDetails()

Returns further details regarding the format validation when the isValidate and isWellFormed are not sufficient to record the validation results.

Returns:

the validation additional details as a string