Constructor Detail

• AAMVA.DLID

  AAMVA.DLID(GenericDocument document)

Method Detail

• getAddressCity

   final TextFieldWrapper getAddressCity()

  Data element ID "DAI". City portion of the cardholder address.

• getAddressJurisdictionCode

   final TextFieldWrapper getAddressJurisdictionCode()

  Data element ID "DAJ". State portion of the cardholder address.

• getAddressPostalCode

   final TextFieldWrapper getAddressPostalCode()

  Data element ID "DAK". Postal code portion of the cardholder address in the U.S. and Canada. If the trailing portion of the postal code in the U.S. is not known, zeros will be used to fill the trailing set of numbers up to nine (9) digits.

• getAddressStreet1

   final TextFieldWrapper getAddressStreet1()

  Data element ID "DAG". Street portion of the cardholder address.

• getAddressStreet2

   final TextFieldWrapper getAddressStreet2()

  Data element ID "DAH". Second line of street portion of the cardholder address.

• getAdultInformation

   final TextFieldWrapper getAdultInformation()

  Data element ID "DCJ". A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If audit information is not used on the card or the MRT, it must be included in the driver record.

• getAliasFamilyName

   final TextFieldWrapper getAliasFamilyName()

  Data element ID "DBN". Other family name by which cardholder is known.

• getAliasGivenName

   final TextFieldWrapper getAliasGivenName()

  Data element ID "DBG". Other given name by which cardholder is known.

• getAliasMiddleName

   final TextFieldWrapper getAliasMiddleName()

  Data element ID "DBQ". Other middle name by which cardholder is known.

• getAliasPrefixName

   final TextFieldWrapper getAliasPrefixName()

  Data element ID "DBR". Other prefix by which cardholder is known.

• getAliasSuffixName

   final TextFieldWrapper getAliasSuffixName()

  Data element ID "DBS". Other suffix by which cardholder is known.

• getCardRevisionDate

   final TextFieldWrapper getCardRevisionDate()

  Data element ID "DDB". DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID. The format is ISO8601 with delimiters.

• getComplianceType

   final TextFieldWrapper getComplianceType()

  Data element ID "DDA". DHS required field that indicates compliance: "F" = compliant; and, "N" = non-compliant.

• getCountryIdentification

   final TextFieldWrapper getCountryIdentification()

  Data element ID "DCG". Country in which DL/ID is issued. U.S. = USA, Canada = CAN.

• getCustomerFamilyName

   final TextFieldWrapper getCustomerFamilyName()

  Data element ID "DCS". Family name of the cardholder. (Family name is sometimes also called “last name” or “surname.”) Collect full name for record, print as many characters as possible on portrait side of DL/ID.

• getCustomerFirstName

   final TextFieldWrapper getCustomerFirstName()

  Data element ID "DAC". First name of the cardholder.

• getCustomerGivenNames

   final TextFieldWrapper getCustomerGivenNames()

  Data element ID "DCT". Given names of the cardholder. (Given names include all names other than the Family Name. This includes all those names sometimes also called “first” and “middle” names.)

• getCustomerIdNumber

   final TextFieldWrapper getCustomerIdNumber()

  Data element ID "DAQ". The number assigned or calculated by the issuing authority.

• getCustomerMiddleName

   final TextFieldWrapper getCustomerMiddleName()

  Data element ID "DAD". Middle name(s) of the cardholder. In the case of multiple middle names they shall be separated by a comma “,”.

• getDateOfBirth

   final TextFieldWrapper getDateOfBirth()

  Data element ID "DBB". Date on which the cardholder was born. The format is ISO8601 with delimiters.

• getDocumentDiscriminator

   final TextFieldWrapper getDocumentDiscriminator()

  Data element ID "DCF". Number must uniquely identify a particular document issued to that customer from others that may have been issued in the past. This number may serve multiple purposes of document discrimination, audit information number, and/or inventory control.

• getDocumentExpirationDate

   final TextFieldWrapper getDocumentExpirationDate()

  Data element ID "DBA". Date on which the driving and identification privileges granted by the document are no longer valid. The format is ISO8601 with delimtiers.

• getDocumentIssueDate

   final TextFieldWrapper getDocumentIssueDate()

  Data element ID "DBD". Date on which the document was issued. The format is ISO8601 with delimiters.

• getDriverAliasDateOfBirthField

   final TextFieldWrapper getDriverAliasDateOfBirthField()

  Data element ID "DBL". Alternative dates given as date of birth.

• getDriverAliasFirstName

   final TextFieldWrapper getDriverAliasFirstName()

  Data element ID "DBP". Alternative fist name or given name of the individual holding the Driver License or ID. Hyphenated names acceptable, but no other use of special symbols.

• getDriverAliasLastName

   final TextFieldWrapper getDriverAliasLastName()

  Data element ID "DBO". Alternative last name or surname of the individual holding the Driver License or ID. Hyphenated names acceptable, but no other use of special symbols.

• getDriverAliasSocialSecurityNumber

   final TextFieldWrapper getDriverAliasSocialSecurityNumber()

  Data element ID "DBM". DriverAliasSocialSecurityNumber

• getDriverLastName

   final TextFieldWrapper getDriverLastName()

  Data element ID "DAB". Last name or surname of the individual holding the Driver License or ID. Hyphenated names acceptable, but no other use of special symbols.

• getDriverLicenseClassificationCode

   final TextFieldWrapper getDriverLicenseClassificationCode()

  Data element ID "DAR". A=Class A; B=Class B; C=Class C (Class A, B and C are defined by Federal Highway regulations); M=Class M motorcycle as defined by AAMVA; others are defined by DL Classification Code Standards.

• getDriverLicenseEndorsementsCode

   final TextFieldWrapper getDriverLicenseEndorsementsCode()

  Data element ID "DAT". Any endorsements on a driver license which authorize the operation of specified types of vehicles or the operation of vehicles carrying specified loads. Endorsements shall be specific to classification of a driver license.

• getDriverLicenseName

   final TextFieldWrapper getDriverLicenseName()

  Data element ID "DAA". Name of the individual holding the Driver License or ID as defined in ANSI D20 Data Dictionary. (Lastname@Firstname@MI@ suffix if any) (Machine, Mag Stripe uses ‘$’ and Bar Code uses ‘,’ in place of ‘@’) Firstname, Middle Initial, Lastname (Human)

• getDriverLicenseRestrictionCode

   final TextFieldWrapper getDriverLicenseRestrictionCode()

  Data element ID "DAS". A restriction applicable to a driver license.

• getDriverNamePrefix

   final TextFieldWrapper getDriverNamePrefix()

  Data element ID "DAF". Prefix to Driver Name. Not defined in ANSI D20. Freeform as defined by issuing jurisdiction.

• getDriverNameSuffix

   final TextFieldWrapper getDriverNameSuffix()

  Data element ID "DAE". An affix occurring at the end of a word, e.g.; Sr., Jr., II, III, IV, etc.

• getDriverPermitClassificationCode

   final TextFieldWrapper getDriverPermitClassificationCode()

  Data element ID "PAA". Identifies the type of permit as defined by ANSI D20.

• getDriverPermitEndorsementCode

   final TextFieldWrapper getDriverPermitEndorsementCode()

  Data element ID "PAF". Permit endorsements as defined by ANSI D20.

• getDriverPermitIssueDate

   final TextFieldWrapper getDriverPermitIssueDate()

  Data element ID "PAD". Date permit was issued. The format is ISO8601 with delimiters.

• getDriverPermitRestrictionCode

   final TextFieldWrapper getDriverPermitRestrictionCode()

  Data element ID "PAE". Permit restrictions as defined by ANSI D20.

• getDriverResidenceCity

   final TextFieldWrapper getDriverResidenceCity()

  Data element ID "DAN". Name of city for mailing address.

• getDriverResidenceJurisdictionCode

   final TextFieldWrapper getDriverResidenceJurisdictionCode()

  Data element ID "DAO". Jurisdiction code for mailing address. Conforms to Canadian, Mexican and US Jurisdictions as appropriate. Codes for provinces (Canada) and states (US and Mexico).

• getDriverResidencePostalCode

   final TextFieldWrapper getDriverResidencePostalCode()

  Data element ID "DAP". Postal code of residence

• getDriverResidenceStreetAddress1

   final TextFieldWrapper getDriverResidenceStreetAddress1()

  Data element ID "DAL". Street address line 1 (mailing).

• getDriverResidenceStreetAddress2

   final TextFieldWrapper getDriverResidenceStreetAddress2()

  Data element ID "DAM". Street address line 2 (mailing).

• getFamilyNameTruncation

   final TextFieldWrapper getFamilyNameTruncation()

  Data element ID "DDE". A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).

• getFederalCommercialVehicleCodes

   final TextFieldWrapper getFederalCommercialVehicleCodes()

  Data element ID "DCH". Federal Commercial Vehicle Codes

• getFirstNameTruncation

   final TextFieldWrapper getFirstNameTruncation()

  Data element ID "DDF". A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).

• getHazmatEndorsementExpirationDate

   final TextFieldWrapper getHazmatEndorsementExpirationDate()

  Data element ID "DDC". Date on which the hazardous material endorsement granted by the document is no longer valid. The format is ISO8601 with delimiters.

• getHairColor

   final TextFieldWrapper getHairColor()

  Data element ID "DAZ". Color of cardholder's hair. ANSI D-20 codes converted to human readable format according to the ANSI D20 Data Dictionary.

• getHeight

   final TextFieldWrapper getHeight()

  Data element ID "DAV". Height in centimeters

• getInventoryControlNumber

   final TextFieldWrapper getInventoryControlNumber()

  Data element ID "DCK". A string of letters and/or numbers that is affixed to the raw materials (card stock, laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field).

• getIssueTimeStamp

   final TextFieldWrapper getIssueTimeStamp()

  Data element ID "DBE". A string used by some jurisdictions to validate the document against their data base.

• getJurisdictionSpecificEndorsementCodeDescription

   final TextFieldWrapper getJurisdictionSpecificEndorsementCodeDescription()

  Data element ID "DCQ". Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class.

• getJurisdictionSpecificEndorsementCodes

   final TextFieldWrapper getJurisdictionSpecificEndorsementCodes()

  Data element ID "DCD". Jurisdiction-specific codes that represent additional privileges granted to the cardholder beyond the vehicle class (such as transportation of passengers, hazardous materials, operation of motorcycles, etc.).

• getJurisdictionSpecificRestrictionCodeDescription

   final TextFieldWrapper getJurisdictionSpecificRestrictionCodeDescription()

  Data element ID "DCR". Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.

• getJurisdictionSpecificRestrictionCodes

   final TextFieldWrapper getJurisdictionSpecificRestrictionCodes()

  Data element ID "DCB". Jurisdiction-specific codes that represent restrictions to driving privileges (such as airbrakes, automatic transmission, daylight only, etc.).

• getJurisdictionSpecificVehicleClass

   final TextFieldWrapper getJurisdictionSpecificVehicleClass()

  Data element ID "DCA". Jurisdiction-specific vehicle class / group code, designating the type of vehicle the cardholder has privilege to drive.

• getJurisdictionSpecificVehicleClassificationDescription

   final TextFieldWrapper getJurisdictionSpecificVehicleClassificationDescription()

  Data element ID "DCP". Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive.

• getLimitedDurationDocumentIndicator

   final TextFieldWrapper getLimitedDurationDocumentIndicator()

  Data element ID "DDD". DHS required field that indicates that the cardholder has temporary lawful status = "1".

• getMiddleNameTruncation

   final TextFieldWrapper getMiddleNameTruncation()

  Data element ID "DDG". A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).

• getNameSuffix

   final TextFieldWrapper getNameSuffix()

  Data element ID "DCU". Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be collected and displayed on the DL/ID and in the MRT). Collect full name for record, print as many characters as possible on portrait side of DL/ID. JR (Junior), SR (Senior), 1ST or I (First), 2ND or II (Second), 3RD or III (Third), 4TH or IV (Fourth), 5TH or V (Fifth), 6TH or VI (Sixth), 7TH or VII (Seventh), 8TH or VIII (Eighth), 9TH or IX (Ninth).

• getNonResidentIndicator

   final TextFieldWrapper getNonResidentIndicator()

  Data element ID "DBI". "Y"; Used by some jurisdictions to indicate holder of the document is a non-resident.

• getNumberOfDuplicates

   final TextFieldWrapper getNumberOfDuplicates()

  Data element ID "DBF". Number of duplicate cards issued for a license or ID if any.

• getOrganDonor

   final TextFieldWrapper getOrganDonor()

  Data element ID "DBH". Organ Donor

• getOrganDonorIndicator

   final TextFieldWrapper getOrganDonorIndicator()

  Data element ID "DDK". Field that indicates that the cardholder is an organ donor = "1".

• getPermitExpirationDate

   final TextFieldWrapper getPermitExpirationDate()

  Data element ID "PAB". Date permit expires, The format is ISO8601 with delimiters.

• getPermitIdentifier

   final TextFieldWrapper getPermitIdentifier()

  Data element ID "PAC". Type of permit.

• getPhysicalDescriptionEyeColor

   final TextFieldWrapper getPhysicalDescriptionEyeColor()

  Data element ID "DAY". Color of cardholder's eyes. ANSI D-20 codes converted to human readable format according to the ANSI D20 Data Dictionary.

• getPhysicalDescriptionHeight

   final TextFieldWrapper getPhysicalDescriptionHeight()

  Data element ID "DAU". Height of cardholder. Inches (in): number of inches followed by " in" or Centimeters (cm): number of centimeters followed by " cm."

• getPhysicalDescriptionSex

   final TextFieldWrapper getPhysicalDescriptionSex()

  Data element ID "DBC". Gender of the cardholder. "Male" or "Female".

• getPhysicalDescriptionWeightRange

   final TextFieldWrapper getPhysicalDescriptionWeightRange()

  Data element ID "DCE". Indicates the approximate weight range of the cardholder: 0 = up to 31 kg (up to 70 lbs), 1 = 32 – 45 kg (71 – 100 lbs), 2 = 46 - 59 kg (101 – 130 lbs), 3 = 60 - 70 kg (131 – 160 lbs), 4 = 71 - 86 kg (161 – 190 lbs), 5 = 87 - 100 kg (191 – 220 lbs), 6 = 101 - 113 kg (221 – 250 lbs), 7 = 114 - 127 kg (251 – 280 lbs), 8 = 128 – 145 kg (281 – 320 lbs), 9 = 146+ kg (321+ lbs).

• getPlaceOfBirth

   final TextFieldWrapper getPlaceOfBirth()

  Data element ID "DCI". Country and municipality and/or state/province.

• getRaceEthnicity

   final TextFieldWrapper getRaceEthnicity()

  Data element ID "DCL". Codes for race or ethnicity of the cardholder. ANSI D-20 codes converted to human readable format according to the ANSI D20 Data Dictionary.

• getSocialSecurityNumber

   final TextFieldWrapper getSocialSecurityNumber()

  Data element ID "DBK". The number assigned to an individual by the Social Security Administration.

• getStandardEndorsementCode

   final TextFieldWrapper getStandardEndorsementCode()

  Data element ID "DCN". Standard endorsement code(s) for cardholder. See codes in D20. This data element is a placeholder for future efforts to standardize endorsement codes.

• getStandardRestrictionCode

   final TextFieldWrapper getStandardRestrictionCode()

  Data element ID "DCO". Standard restriction code(s) for cardholder. See codes in D20. This data element is a placeholder for future efforts to standardize restriction codes.

• getStandardVehicleClassification

   final TextFieldWrapper getStandardVehicleClassification()

  Data element ID "DCM". Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to standardize vehicle classifications.

• getUnder18Until

   final TextFieldWrapper getUnder18Until()

  Data element ID "DDH". Date on which the cardholder turns 18 years old. The format is ISO8601 with delimiters.

• getUnder19Until

   final TextFieldWrapper getUnder19Until()

  Data element ID "DDI". Date on which the cardholder turns 19 years old. The format is ISO8601 with delimiters.

• getUnder21Until

   final TextFieldWrapper getUnder21Until()

  Data element ID "DDJ". Date on which the cardholder turns 21 years old. The format is ISO8601 with delimiters.

• getUniqueCustomerIdentifier

   final TextFieldWrapper getUniqueCustomerIdentifier()

  Data element ID "DBJ". A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases.

• getVeteranIndicator

   final TextFieldWrapper getVeteranIndicator()

  Data element ID "DDL". Field that indicates that the cardholder is a veteran = "1".

• getWeightKilograms

   final TextFieldWrapper getWeightKilograms()

  Data element ID "DAX". Cardholder weight in kilograms Ex. 84 kg = "084"

• getWeightPounds

   final TextFieldWrapper getWeightPounds()

  Data element ID "DAW". Cardholder weight in pounds Ex. 185 lb = "185"