All Implemented Interfaces:

java.io.Serializable
```
public class MrzFieldScanOptions
 implements Serializable
                    
```
The fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`MrzFieldScanOptions.MrzScanOption`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Field Summary

Fields
Modifier and Type	Field	Description
`public MrzFieldScanOptions.MrzScanOption`	`surname`
`public MrzFieldScanOptions.MrzScanOption`	`givenNames`
`public MrzFieldScanOptions.MrzScanOption`	`dateOfBirth`
`public MrzFieldScanOptions.MrzScanOption`	`dateOfExpiry`
`public MrzFieldScanOptions.MrzScanOption`	`documentNumber`
`public MrzFieldScanOptions.MrzScanOption`	`documentType`
`public MrzFieldScanOptions.MrzScanOption`	`issuingCountryCode`
`public MrzFieldScanOptions.MrzScanOption`	`nationalityCountryCode`
`public MrzFieldScanOptions.MrzScanOption`	`sex`
`public MrzFieldScanOptions.MrzScanOption`	`personalNumber`
`public MrzFieldScanOptions.MrzScanOption`	`optionalData`
`public MrzFieldScanOptions.MrzScanOption`	`mrzString`
`public MrzFieldScanOptions.MrzScanOption`	`checkDigitDateOfExpiry`
`public MrzFieldScanOptions.MrzScanOption`	`checkDigitDocumentNumber`
`public MrzFieldScanOptions.MrzScanOption`	`checkDigitPersonalNumber`
`public MrzFieldScanOptions.MrzScanOption`	`checkDigitDateOfBirth`
`public MrzFieldScanOptions.MrzScanOption`	`checkDigitFinal`
`public MrzFieldScanOptions.MrzScanOption`	`vizAddress`
`public MrzFieldScanOptions.MrzScanOption`	`vizDateOfIssue`
`public MrzFieldScanOptions.MrzScanOption`	`vizSurname`
`public MrzFieldScanOptions.MrzScanOption`	`vizGivenNames`
`public MrzFieldScanOptions.MrzScanOption`	`vizDateOfBirth`
`public MrzFieldScanOptions.MrzScanOption`	`vizDateOfExpiry`

Constructor Summary

Constructors
Constructor	Description
`MrzFieldScanOptions()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`MrzFieldScanOptions.MrzScanOption`	`getSurname()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setSurname(MrzFieldScanOptions.MrzScanOption surname)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getGivenNames()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setGivenNames(MrzFieldScanOptions.MrzScanOption givenNames)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getDateOfBirth()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setDateOfBirth(MrzFieldScanOptions.MrzScanOption dateOfBirth)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getDateOfExpiry()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setDateOfExpiry(MrzFieldScanOptions.MrzScanOption dateOfExpiry)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getDocumentNumber()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setDocumentNumber(MrzFieldScanOptions.MrzScanOption documentNumber)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getDocumentType()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setDocumentType(MrzFieldScanOptions.MrzScanOption documentType)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getIssuingCountryCode()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setIssuingCountryCode(MrzFieldScanOptions.MrzScanOption issuingCountryCode)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getNationalityCountryCode()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setNationalityCountryCode(MrzFieldScanOptions.MrzScanOption nationalityCountryCode)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getSex()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setSex(MrzFieldScanOptions.MrzScanOption sex)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getPersonalNumber()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setPersonalNumber(MrzFieldScanOptions.MrzScanOption personalNumber)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getOptionalData()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setOptionalData(MrzFieldScanOptions.MrzScanOption optionalData)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getMrzString()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setMrzString(MrzFieldScanOptions.MrzScanOption mrzString)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getCheckDigitDateOfExpiry()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setCheckDigitDateOfExpiry(MrzFieldScanOptions.MrzScanOption checkDigitDateOfExpiry)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getCheckDigitDocumentNumber()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setCheckDigitDocumentNumber(MrzFieldScanOptions.MrzScanOption checkDigitDocumentNumber)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getCheckDigitPersonalNumber()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setCheckDigitPersonalNumber(MrzFieldScanOptions.MrzScanOption checkDigitPersonalNumber)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getCheckDigitDateOfBirth()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setCheckDigitDateOfBirth(MrzFieldScanOptions.MrzScanOption checkDigitDateOfBirth)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getCheckDigitFinal()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setCheckDigitFinal(MrzFieldScanOptions.MrzScanOption checkDigitFinal)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getVizAddress()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setVizAddress(MrzFieldScanOptions.MrzScanOption vizAddress)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getVizDateOfIssue()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setVizDateOfIssue(MrzFieldScanOptions.MrzScanOption vizDateOfIssue)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getVizSurname()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setVizSurname(MrzFieldScanOptions.MrzScanOption vizSurname)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getVizGivenNames()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setVizGivenNames(MrzFieldScanOptions.MrzScanOption vizGivenNames)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getVizDateOfBirth()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setVizDateOfBirth(MrzFieldScanOptions.MrzScanOption vizDateOfBirth)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`MrzFieldScanOptions.MrzScanOption`	`getVizDateOfExpiry()`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`void`	`setVizDateOfExpiry(MrzFieldScanOptions.MrzScanOption vizDateOfExpiry)`	The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
`String`	`toString()`
`int`	`hashCode()`
`boolean`	`equals(Object other)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MrzFieldScanOptions
```
MrzFieldScanOptions()
```
- Method Detail
  - getSurname
```
 MrzFieldScanOptions.MrzScanOption getSurname()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setSurname
```
 void setSurname(MrzFieldScanOptions.MrzScanOption surname)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getGivenNames
```
 MrzFieldScanOptions.MrzScanOption getGivenNames()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setGivenNames
```
 void setGivenNames(MrzFieldScanOptions.MrzScanOption givenNames)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getDateOfBirth
```
 MrzFieldScanOptions.MrzScanOption getDateOfBirth()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setDateOfBirth
```
 void setDateOfBirth(MrzFieldScanOptions.MrzScanOption dateOfBirth)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getDateOfExpiry
```
 MrzFieldScanOptions.MrzScanOption getDateOfExpiry()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setDateOfExpiry
```
 void setDateOfExpiry(MrzFieldScanOptions.MrzScanOption dateOfExpiry)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getDocumentNumber
```
 MrzFieldScanOptions.MrzScanOption getDocumentNumber()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setDocumentNumber
```
 void setDocumentNumber(MrzFieldScanOptions.MrzScanOption documentNumber)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getDocumentType
```
 MrzFieldScanOptions.MrzScanOption getDocumentType()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setDocumentType
```
 void setDocumentType(MrzFieldScanOptions.MrzScanOption documentType)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getIssuingCountryCode
```
 MrzFieldScanOptions.MrzScanOption getIssuingCountryCode()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setIssuingCountryCode
```
 void setIssuingCountryCode(MrzFieldScanOptions.MrzScanOption issuingCountryCode)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getNationalityCountryCode
```
 MrzFieldScanOptions.MrzScanOption getNationalityCountryCode()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setNationalityCountryCode
```
 void setNationalityCountryCode(MrzFieldScanOptions.MrzScanOption nationalityCountryCode)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getSex
```
 MrzFieldScanOptions.MrzScanOption getSex()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setSex
```
 void setSex(MrzFieldScanOptions.MrzScanOption sex)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getPersonalNumber
```
 MrzFieldScanOptions.MrzScanOption getPersonalNumber()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setPersonalNumber
```
 void setPersonalNumber(MrzFieldScanOptions.MrzScanOption personalNumber)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getOptionalData
```
 MrzFieldScanOptions.MrzScanOption getOptionalData()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setOptionalData
```
 void setOptionalData(MrzFieldScanOptions.MrzScanOption optionalData)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getMrzString
```
 MrzFieldScanOptions.MrzScanOption getMrzString()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setMrzString
```
 void setMrzString(MrzFieldScanOptions.MrzScanOption mrzString)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getCheckDigitDateOfExpiry
```
 MrzFieldScanOptions.MrzScanOption getCheckDigitDateOfExpiry()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setCheckDigitDateOfExpiry
```
 void setCheckDigitDateOfExpiry(MrzFieldScanOptions.MrzScanOption checkDigitDateOfExpiry)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getCheckDigitDocumentNumber
```
 MrzFieldScanOptions.MrzScanOption getCheckDigitDocumentNumber()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setCheckDigitDocumentNumber
```
 void setCheckDigitDocumentNumber(MrzFieldScanOptions.MrzScanOption checkDigitDocumentNumber)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getCheckDigitPersonalNumber
```
 MrzFieldScanOptions.MrzScanOption getCheckDigitPersonalNumber()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setCheckDigitPersonalNumber
```
 void setCheckDigitPersonalNumber(MrzFieldScanOptions.MrzScanOption checkDigitPersonalNumber)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getCheckDigitDateOfBirth
```
 MrzFieldScanOptions.MrzScanOption getCheckDigitDateOfBirth()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setCheckDigitDateOfBirth
```
 void setCheckDigitDateOfBirth(MrzFieldScanOptions.MrzScanOption checkDigitDateOfBirth)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getCheckDigitFinal
```
 MrzFieldScanOptions.MrzScanOption getCheckDigitFinal()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setCheckDigitFinal
```
 void setCheckDigitFinal(MrzFieldScanOptions.MrzScanOption checkDigitFinal)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getVizAddress
```
 MrzFieldScanOptions.MrzScanOption getVizAddress()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setVizAddress
```
 void setVizAddress(MrzFieldScanOptions.MrzScanOption vizAddress)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getVizDateOfIssue
```
 MrzFieldScanOptions.MrzScanOption getVizDateOfIssue()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setVizDateOfIssue
```
 void setVizDateOfIssue(MrzFieldScanOptions.MrzScanOption vizDateOfIssue)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getVizSurname
```
 MrzFieldScanOptions.MrzScanOption getVizSurname()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setVizSurname
```
 void setVizSurname(MrzFieldScanOptions.MrzScanOption vizSurname)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getVizGivenNames
```
 MrzFieldScanOptions.MrzScanOption getVizGivenNames()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setVizGivenNames
```
 void setVizGivenNames(MrzFieldScanOptions.MrzScanOption vizGivenNames)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getVizDateOfBirth
```
 MrzFieldScanOptions.MrzScanOption getVizDateOfBirth()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setVizDateOfBirth
```
 void setVizDateOfBirth(MrzFieldScanOptions.MrzScanOption vizDateOfBirth)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - getVizDateOfExpiry
```
 MrzFieldScanOptions.MrzScanOption getVizDateOfExpiry()
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - setVizDateOfExpiry
```
 void setVizDateOfExpiry(MrzFieldScanOptions.MrzScanOption vizDateOfExpiry)
```
    The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
  - toString
```
 String toString()
```
  - hashCode
```
 int hashCode()
```
  - equals
```
 boolean equals(Object other)
```

Class MrzFieldScanOptions

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrzFieldScanOptions

Method Detail

getSurname

setSurname

getGivenNames

setGivenNames

getDateOfBirth

setDateOfBirth

getDateOfExpiry

setDateOfExpiry

getDocumentNumber

setDocumentNumber

getDocumentType

setDocumentType

getIssuingCountryCode

setIssuingCountryCode

getNationalityCountryCode

setNationalityCountryCode

getSex

setSex

getPersonalNumber

setPersonalNumber

getOptionalData

setOptionalData

getMrzString

setMrzString

getCheckDigitDateOfExpiry

setCheckDigitDateOfExpiry

getCheckDigitDocumentNumber

setCheckDigitDocumentNumber

getCheckDigitPersonalNumber

setCheckDigitPersonalNumber

getCheckDigitDateOfBirth

setCheckDigitDateOfBirth

getCheckDigitFinal

setCheckDigitFinal

getVizAddress

setVizAddress

getVizDateOfIssue

setVizDateOfIssue

getVizSurname

setVizSurname

getVizGivenNames

setVizGivenNames

getVizDateOfBirth

setVizDateOfBirth

getVizDateOfExpiry

setVizDateOfExpiry

toString

hashCode

equals