Comment on page

GreenBookModel

A class derived from DocumentModel containing details pertaining to all green book documents

import com.sybrin.identity.models.GreenBookModel
extends DocumentModel​
Summary
Public methods
​
Data source
​GreenBookType​
​getBookType()
​
Returns the language type of the 
green book document.
OCR
String
​getCountryOfBirth()
OCR
Date
​getDateIssued()
OCR
Date
​getDateOfBirth()
OCR
String
​getFirstNames()
OCR
String
​getIdentityNumber()
OCR
String
​getSurname()
OCR
Inherited methods
​DocumentModel​
​
Data source
<T extends DocumentModel>
​castToModel(Class<T> class)
​
Casts the current model to the
type specified by the class parameter.
N/A
Bitmap
​getCroppedDocumentImage()
Front of document
String
​getCroppedDocumentImagePath()
Local storage
Bitmap
​getDocumentImage()
Front of document
String
​getDocumentImagePath()
Local storage
Bitmap
​getPortraitImage()
Front of document
String
​getPortraitImagePath()
Local storage
void
​saveImages(Context context)
​
Saves all images within the model
to the local device and populates
all path fields.
N/A
Public methods
getBookType
public GreenBookType getBookType ()
Returns the language type that the green book ID conforms to.
Returns
​
​GreenBookType​
The document's language type. This value cannot be null.
​
getCountryOfBirth
public String getCountryOfBirth ()
Returns the subject's country of birth as found on the green book document.
Returns
​
String
The subject's country of birth. This value cannot be null.
​
getDateIssued
public Date getDateIssued ()
Returns the document's issue date as found on the green book document.
Returns
​
Date
The document's issue date. This value cannot be null.
​
getDateOfBirth
public Date getDateOfBirth ()
Returns the subject's date of birth as found on the green book document.
Returns
​
Date
The subject's date of birth. This value cannot be null.
​
getFirstNames
public String getFirstNames ()
Returns the subject's first names as found on the green book document.
Returns
​
String
The subject's first names. This value cannot be null.
​
getIdentityNumber
public String getIdentityNumber ()
Returns the subject's identity number as found on the green book document.
Returns
​
String
The subject's identity number. This value cannot be null.
​
getSurname
public String getSurname ()
Returns the subject's surname as found on the green book document.
Returns
​
String
The subject's surname. This value cannot be null.

GhanaPassportModel

IDCardModel

Last modified 1yr ago

Public methods		Data source
GreenBookType	getBookType() Returns the language type of the green book document.	OCR
String	getCountryOfBirth()	OCR
Date	getDateIssued()	OCR
Date	getDateOfBirth()	OCR
String	getFirstNames()	OCR
String	getIdentityNumber()	OCR
String	getSurname()	OCR

DocumentModel		Data source
<T extends DocumentModel>	castToModel(Class<T> class) Casts the current model to the type specified by the class parameter.	N/A
Bitmap	getCroppedDocumentImage()	Front of document
String	getCroppedDocumentImagePath()	Local storage
Bitmap	getDocumentImage()	Front of document
String	getDocumentImagePath()	Local storage
Bitmap	getPortraitImage()	Front of document
String	getPortraitImagePath()	Local storage
void	saveImages(Context context) Saves all images within the model to the local device and populates all path fields.	N/A

Returns
GreenBookType	The document's language type. This value cannot be `null`.

Returns
String	The subject's country of birth. This value cannot be `null`.

Returns
Date	The document's issue date. This value cannot be `null`.

Returns
Date	The subject's date of birth. This value cannot be `null`.

Returns
String	The subject's first names. This value cannot be `null`.

Returns
String	The subject's identity number. This value cannot be `null`.

Returns
String	The subject's surname. This value cannot be `null`.