Package io.scanbot.sdk.documentdata

Class SemanticsVerificationReport

java.lang.Object

io.scanbot.sdk.documentdata.SemanticsVerificationReport

public class SemanticsVerificationReport
extends java.lang.Object

Report of the document value semantics verification.

Constructor Summary

Constructors

Constructor	Description
SemanticsVerificationReport(boolean overallInvalidSemantics, CompositeFieldValueSemantics expiryDateSemantics, CompositeFieldValueSemantics issueDateSemantics, CompositeFieldValueSemantics birthDateSemantics, ValueSemantics issueDateBeforeExpiryDate, ValueSemantics birthDateBeforeIssueDate, ValueSemantics birthDateBeforeExpiryDate)	Constructs SemanticsVerificationReport with the given params.

Method Summary

Modifier and Type	Method	Description
ValueSemantics	getBirthDateBeforeExpiryDate()	Getter for birthDateBeforeExpiryDate field.
ValueSemantics	getBirthDateBeforeIssueDate()	Getter for birthDateBeforeIssueDate field.
CompositeFieldValueSemantics	getBirthDateSemantics()	Getter for birthDateSemantics field.
CompositeFieldValueSemantics	getExpiryDateSemantics()	Getter for expiryDateSemantics field.
ValueSemantics	getIssueDateBeforeExpiryDate()	Getter for issueDateBeforeExpiryDate field.
CompositeFieldValueSemantics	getIssueDateSemantics()	Getter for issueDateSemantics field.
boolean	getOverallInvalidSemantics()	Getter for overallInvalidSemantics field.

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticsVerificationReport

public SemanticsVerificationReport(boolean overallInvalidSemantics,
                                   CompositeFieldValueSemantics expiryDateSemantics,
                                   CompositeFieldValueSemantics issueDateSemantics,
                                   CompositeFieldValueSemantics birthDateSemantics,
                                   ValueSemantics issueDateBeforeExpiryDate,
                                   ValueSemantics birthDateBeforeIssueDate,
                                   ValueSemantics birthDateBeforeExpiryDate)

Constructs SemanticsVerificationReport with the given params.

Parameters:

overallInvalidSemantics - Overall status of the value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If some verifications are skipped, they do not impact the overall status.

expiryDateSemantics - Status of the expiry date semantics verification. Shows whether the expiry date in the document is in the future.

issueDateSemantics - Status of the issue date semantics verification. Shows whether the issue date in the document is in the past.

birthDateSemantics - Status of the birth date semantics verification. Shows whether the birth date in the document is in the past.

issueDateBeforeExpiryDate - Result of verification whether the issue date is before the expiry date.

birthDateBeforeIssueDate - Result of verification whether the birth date is before the issue date.

birthDateBeforeExpiryDate - Result of verification whether the birth date is before the expiry date.

Method Detail

getOverallInvalidSemantics

public boolean getOverallInvalidSemantics()

Getter for overallInvalidSemantics field. See constructor documentation for more information about the field.

Returns:

overallInvalidSemantics

getExpiryDateSemantics

public CompositeFieldValueSemantics getExpiryDateSemantics()

Getter for expiryDateSemantics field. See constructor documentation for more information about the field.

Returns:

expiryDateSemantics

getIssueDateSemantics

public CompositeFieldValueSemantics getIssueDateSemantics()

Getter for issueDateSemantics field. See constructor documentation for more information about the field.

Returns:

issueDateSemantics

getBirthDateSemantics

public CompositeFieldValueSemantics getBirthDateSemantics()

Getter for birthDateSemantics field. See constructor documentation for more information about the field.

Returns:

birthDateSemantics

getIssueDateBeforeExpiryDate

public ValueSemantics getIssueDateBeforeExpiryDate()

Getter for issueDateBeforeExpiryDate field. See constructor documentation for more information about the field.

Returns:

issueDateBeforeExpiryDate

getBirthDateBeforeIssueDate

public ValueSemantics getBirthDateBeforeIssueDate()

Getter for birthDateBeforeIssueDate field. See constructor documentation for more information about the field.

Returns:

birthDateBeforeIssueDate

getBirthDateBeforeExpiryDate

public ValueSemantics getBirthDateBeforeExpiryDate()

Getter for birthDateBeforeExpiryDate field. See constructor documentation for more information about the field.

Returns:

birthDateBeforeExpiryDate