Document (JiBX/OTA Full Model)

Overview

Package

Class

Tree

Deprecated

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.ota.shared
Class Document

java.lang.Object
  org.ota.shared.Document

Direct Known Subclasses:: AirCheckIn.PassengerFlightInfo.APIInfo, AirTraveler.Document

public class Document
extends java.lang.Object
extends java.lang.Object

Provides information on a specific document. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="DocumentType">
   <xs:sequence>
     <xs:choice minOccurs="0">
       <!-- Reference to inner class Choice -->
     </xs:choice>
     <xs:element type="xs:string" name="DocLimitations" minOccurs="0" maxOccurs="9"/>
     <xs:element name="AdditionalPersonNames" minOccurs="0">
       <!-- Reference to inner class AdditionalPersonNames -->
     </xs:element>
   </xs:sequence>
   <xs:attributeGroup ref="ns:PrivacyGroup"/>
   <xs:attribute type="xs:string" use="optional" name="DocIssueAuthority"/>
   <xs:attribute type="xs:string" use="optional" name="DocIssueLocation"/>
   <xs:attribute type="xs:string" use="optional" name="DocID"/>
   <xs:attribute type="xs:string" use="optional" name="DocType"/>
   <xs:attributeGroup ref="ns:GenderGroup"/>
   <xs:attributeGroup ref="ns:BirthDateGroup"/>
   <xs:attributeGroup ref="ns:EffectiveExpireOptionalDateGroup"/>
   <xs:attribute type="xs:string" use="optional" name="DocIssueStateProv"/>
   <xs:attribute type="xs:string" use="optional" name="DocIssueCountry"/>
   <xs:attribute type="xs:string" use="optional" name="BirthCountry"/>
   <xs:attribute type="xs:string" use="optional" name="BirthPlace"/>
   <xs:attribute type="xs:string" use="optional" name="DocHolderNationality"/>
   <xs:attribute type="xs:string" use="optional" name="ContactName"/>
   <xs:attribute use="optional" name="HolderType">
     <xs:simpleType>
       <!-- Reference to inner class Holder -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute type="xs:string" use="optional" name="Remark"/>
   <xs:attribute type="xs:string" use="optional" name="PostalCode"/>
 </xs:complexType>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="BirthDateGroup">
   <xs:attribute type="xs:date" use="optional" name="BirthDate"/>
 </xs:attributeGroup>

Nested Class Summary
`static class`	`Document.AdditionalPersonNames` A container for additional person names.
`static class`	`Document.Choice` Schema fragment(s) for this class:
`static class`	`Document.Holder` Schema fragment(s) for this class:

Constructor Summary
`Document()`

Method Summary
`void`	`addDocLimitation(java.lang.String item)` Add a 'DocLimitations' element item.
`void`	`clearDocLimitations()` Remove all 'DocLimitations' element items.
`Document.AdditionalPersonNames`	`getAdditionalPersonNames()` Get the 'AdditionalPersonNames' element value.
`java.lang.String`	`getBirthCountry()` Get the 'BirthCountry' attribute value.
`java.sql.Date`	`getBirthDate()` Get the 'BirthDate' attribute value.
`java.lang.String`	`getBirthPlace()` Get the 'BirthPlace' attribute value.
`Document.Choice`	`getChoice()` Get the choice value.
`java.lang.String`	`getContactName()` Get the 'ContactName' attribute value.
`java.lang.String`	`getDoc()` Get the 'DocType' attribute value.
`java.lang.String`	`getDocHolderNationality()` Get the 'DocHolderNationality' attribute value.
`java.lang.String`	`getDocID()` Get the 'DocID' attribute value.
`java.lang.String`	`getDocIssueAuthority()` Get the 'DocIssueAuthority' attribute value.
`java.lang.String`	`getDocIssueCountry()` Get the 'DocIssueCountry' attribute value.
`java.lang.String`	`getDocIssueLocation()` Get the 'DocIssueLocation' attribute value.
`java.lang.String`	`getDocIssueStateProv()` Get the 'DocIssueStateProv' attribute value.
`java.lang.String`	`getDocLimitation(int index)` Get 'DocLimitations' element item by position.
`java.util.List<java.lang.String>`	`getDocLimitations()` Get the list of 'DocLimitations' element items.
`EffectiveExpireOptionalDateGroup`	`getEffectiveExpireOptionalDateGroup()` Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
`GenderGroup`	`getGenderGroup()` Get the 'GenderGroup' attributeGroup value.
`Document.Holder`	`getHolder()` Get the 'HolderType' attribute value.
`java.lang.String`	`getPostalCode()` Get the 'PostalCode' attribute value.
`PrivacyGroup`	`getPrivacyGroup()` Get the 'PrivacyGroup' attributeGroup value.
`java.lang.String`	`getRemark()` Get the 'Remark' attribute value.
`void`	`setAdditionalPersonNames(Document.AdditionalPersonNames additionalPersonNames)` Set the 'AdditionalPersonNames' element value.
`void`	`setBirthCountry(java.lang.String birthCountry)` Set the 'BirthCountry' attribute value.
`void`	`setBirthDate(java.sql.Date birthDate)` Set the 'BirthDate' attribute value.
`void`	`setBirthPlace(java.lang.String birthPlace)` Set the 'BirthPlace' attribute value.
`void`	`setChoice(Document.Choice choice)` Set the choice value.
`void`	`setContactName(java.lang.String contactName)` Set the 'ContactName' attribute value.
`void`	`setDoc(java.lang.String doc)` Set the 'DocType' attribute value.
`void`	`setDocHolderNationality(java.lang.String docHolderNationality)` Set the 'DocHolderNationality' attribute value.
`void`	`setDocID(java.lang.String docID)` Set the 'DocID' attribute value.
`void`	`setDocIssueAuthority(java.lang.String docIssueAuthority)` Set the 'DocIssueAuthority' attribute value.
`void`	`setDocIssueCountry(java.lang.String docIssueCountry)` Set the 'DocIssueCountry' attribute value.
`void`	`setDocIssueLocation(java.lang.String docIssueLocation)` Set the 'DocIssueLocation' attribute value.
`void`	`setDocIssueStateProv(java.lang.String docIssueStateProv)` Set the 'DocIssueStateProv' attribute value.
`void`	`setDocLimitations(java.util.List<java.lang.String> list)` Set the list of 'DocLimitations' element items.
`void`	`setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)` Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
`void`	`setGenderGroup(GenderGroup genderGroup)` Set the 'GenderGroup' attributeGroup value.
`void`	`setHolder(Document.Holder holder)` Set the 'HolderType' attribute value.
`void`	`setPostalCode(java.lang.String postalCode)` Set the 'PostalCode' attribute value.
`void`	`setPrivacyGroup(PrivacyGroup privacyGroup)` Set the 'PrivacyGroup' attributeGroup value.
`void`	`setRemark(java.lang.String remark)` Set the 'Remark' attribute value.
`int`	`sizeDocLimitations()` Get the number of 'DocLimitations' element items.

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

Constructor Detail

Document

public Document()

Method Detail

getChoice

public Document.Choice getChoice()

Get the choice value.

Returns:: value

setChoice

public void setChoice(Document.Choice choice)

Set the choice value.

Parameters:: choice -

getDocLimitations

public java.util.List<java.lang.String> getDocLimitations()

Get the list of 'DocLimitations' element items. Used to indicate any limitations on the document (e.g. as a person may only be allowed to spend a max of 30 days in country on a visitor's visa).

Returns:: list

setDocLimitations

public void setDocLimitations(java.util.List<java.lang.String> list)

Set the list of 'DocLimitations' element items. Used to indicate any limitations on the document (e.g. as a person may only be allowed to spend a max of 30 days in country on a visitor's visa).

Parameters:: list -

sizeDocLimitations

public int sizeDocLimitations()

Get the number of 'DocLimitations' element items.

Returns:: count

addDocLimitation

public void addDocLimitation(java.lang.String item)

Add a 'DocLimitations' element item.

Parameters:: item -

getDocLimitation

public java.lang.String getDocLimitation(int index)

Get 'DocLimitations' element item by position.

Parameters:: index -
Returns:: item

clearDocLimitations

public void clearDocLimitations()

Remove all 'DocLimitations' element items.

getAdditionalPersonNames

public Document.AdditionalPersonNames getAdditionalPersonNames()

Get the 'AdditionalPersonNames' element value.

Returns:: value

setAdditionalPersonNames

public void setAdditionalPersonNames(Document.AdditionalPersonNames additionalPersonNames)

Set the 'AdditionalPersonNames' element value.

Parameters:: additionalPersonNames -

getPrivacyGroup

public PrivacyGroup getPrivacyGroup()

Get the 'PrivacyGroup' attributeGroup value. Allows for control of the sharing of document data between parties.

Returns:: value

setPrivacyGroup

public void setPrivacyGroup(PrivacyGroup privacyGroup)

Set the 'PrivacyGroup' attributeGroup value. Allows for control of the sharing of document data between parties.

Parameters:: privacyGroup -

getDocIssueAuthority

public java.lang.String getDocIssueAuthority()

Get the 'DocIssueAuthority' attribute value. Indicates the group or association that granted the document.

Returns:: value

setDocIssueAuthority

public void setDocIssueAuthority(java.lang.String docIssueAuthority)

Set the 'DocIssueAuthority' attribute value. Indicates the group or association that granted the document.

Parameters:: docIssueAuthority -

getDocIssueLocation

public java.lang.String getDocIssueLocation()

Get the 'DocIssueLocation' attribute value. Indicates the location where the document was issued.

Returns:: value

setDocIssueLocation

public void setDocIssueLocation(java.lang.String docIssueLocation)

Set the 'DocIssueLocation' attribute value. Indicates the location where the document was issued.

Parameters:: docIssueLocation -

getDocID

public java.lang.String getDocID()

Get the 'DocID' attribute value. Unique number assigned by authorities to document.

Returns:: value

setDocID

public void setDocID(java.lang.String docID)

Set the 'DocID' attribute value. Unique number assigned by authorities to document.

Parameters:: docID -

getDoc

public java.lang.String getDoc()

Get the 'DocType' attribute value. Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate). Refer to OpenTravel Code List Document Type (DOC).

Returns:: value

setDoc

public void setDoc(java.lang.String doc)

Set the 'DocType' attribute value. Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate). Refer to OpenTravel Code List Document Type (DOC).

Parameters:: doc -

getGenderGroup

public GenderGroup getGenderGroup()

Get the 'GenderGroup' attributeGroup value. The gender of the document holder.

Returns:: value

setGenderGroup

public void setGenderGroup(GenderGroup genderGroup)

Set the 'GenderGroup' attributeGroup value. The gender of the document holder.

Parameters:: genderGroup -

getBirthDate

public java.sql.Date getBirthDate()

Get the 'BirthDate' attribute value. Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.

Returns:: value

setBirthDate

public void setBirthDate(java.sql.Date birthDate)

Set the 'BirthDate' attribute value. Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.

Parameters:: birthDate -

getEffectiveExpireOptionalDateGroup

public EffectiveExpireOptionalDateGroup getEffectiveExpireOptionalDateGroup()

Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value. The effective and expiry date of the document.

Returns:: value

setEffectiveExpireOptionalDateGroup

public void setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)

Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value. The effective and expiry date of the document.

Parameters:: effectiveExpireOptionalDateGroup -

getDocIssueStateProv

public java.lang.String getDocIssueStateProv()

Get the 'DocIssueStateProv' attribute value. State or Province where the document was issued.

Returns:: value

setDocIssueStateProv

public void setDocIssueStateProv(java.lang.String docIssueStateProv)

Set the 'DocIssueStateProv' attribute value. State or Province where the document was issued.

Parameters:: docIssueStateProv -

getDocIssueCountry

public java.lang.String getDocIssueCountry()

Get the 'DocIssueCountry' attribute value. Country where the document was issued.

Returns:: value

setDocIssueCountry

public void setDocIssueCountry(java.lang.String docIssueCountry)

Set the 'DocIssueCountry' attribute value. Country where the document was issued.

Parameters:: docIssueCountry -

getBirthCountry

public java.lang.String getBirthCountry()

Get the 'BirthCountry' attribute value. Specifies the birth country of the document holder.

Returns:: value

setBirthCountry

public void setBirthCountry(java.lang.String birthCountry)

Set the 'BirthCountry' attribute value. Specifies the birth country of the document holder.

Parameters:: birthCountry -

getBirthPlace

public java.lang.String getBirthPlace()

Get the 'BirthPlace' attribute value. Specifies the birth place of the document holder (e.g., city, state, county, province), when designating a country of birth, use BirthCountry.

Returns:: value

setBirthPlace

public void setBirthPlace(java.lang.String birthPlace)

Set the 'BirthPlace' attribute value. Specifies the birth place of the document holder (e.g., city, state, county, province), when designating a country of birth, use BirthCountry.

Parameters:: birthPlace -

getDocHolderNationality

public java.lang.String getDocHolderNationality()

Get the 'DocHolderNationality' attribute value. The country code of the nationality of the document holder.

Returns:: value

setDocHolderNationality

public void setDocHolderNationality(java.lang.String docHolderNationality)

Set the 'DocHolderNationality' attribute value. The country code of the nationality of the document holder.

Parameters:: docHolderNationality -

getContactName

public java.lang.String getContactName()

Get the 'ContactName' attribute value. Provides contact name associated with the document.

Returns:: value

setContactName

public void setContactName(java.lang.String contactName)

Set the 'ContactName' attribute value. Provides contact name associated with the document.

Parameters:: contactName -

getHolder

public Document.Holder getHolder()

Get the 'HolderType' attribute value. Provides the type of document holder.

Returns:: value

setHolder

public void setHolder(Document.Holder holder)

Set the 'HolderType' attribute value. Provides the type of document holder.

Parameters:: holder -

getRemark

public java.lang.String getRemark()

Get the 'Remark' attribute value. A remark associated with the document.

Returns:: value

setRemark

public void setRemark(java.lang.String remark)

Set the 'Remark' attribute value. A remark associated with the document.

Parameters:: remark -

getPostalCode

public java.lang.String getPostalCode()

Get the 'PostalCode' attribute value. Defines the postal code (e.g., ZIP code) on the document.

Returns:: value

setPostalCode

public void setPostalCode(java.lang.String postalCode)

Set the 'PostalCode' attribute value. Defines the postal code (e.g., ZIP code) on the document.

Parameters:: postalCode -