Address (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 Address

java.lang.Object
  org.ota.shared.Address

Direct Known Subclasses:: AddressInfo, AirTraveler.Address, ItemSearchCriterion.Address, OffLocationServiceCore.Address, TripFeatures.Destinations.Destination

public class Address
extends java.lang.Object
extends java.lang.Object

Provides address information. 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="AddressType">
   <xs:sequence>
     <xs:element name="StreetNmbr" minOccurs="0">
       <!-- Reference to inner class StreetNmbr -->
     </xs:element>
     <xs:element name="BldgRoom" minOccurs="0" maxOccurs="2">
       <!-- Reference to inner class BldgRoom -->
     </xs:element>
     <xs:element type="xs:string" name="AddressLine" minOccurs="0" maxOccurs="5"/>
     <xs:element type="xs:string" name="CityName" minOccurs="0"/>
     <xs:element type="xs:string" name="PostalCode" minOccurs="0"/>
     <xs:element type="xs:string" name="County" minOccurs="0"/>
     <xs:element type="ns:StateProvType" name="StateProv" minOccurs="0"/>
     <xs:element type="ns:CountryNameType" name="CountryName" minOccurs="0"/>
   </xs:sequence>
   <xs:attributeGroup ref="ns:FormattedInd"/>
   <xs:attributeGroup ref="ns:PrivacyGroup"/>
   <xs:attribute type="xs:string" use="optional" name="Type"/>
   <xs:attribute type="xs:string" use="optional" name="Remark"/>
 </xs:complexType>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="FormattedInd">
   <xs:attribute type="xs:boolean" use="optional" name="FormattedInd"/>
 </xs:attributeGroup>

Nested Class Summary
`static class`	`Address.BldgRoom` Building name, room, apartment, or suite number.
`static class`	`Address.StreetNmbr` May contain the street number and optionally the street name.

Constructor Summary
`Address()`

Method Summary
`void`	`addAddressLine(java.lang.String item)` Add a 'AddressLine' element item.
`void`	`addBldgRoom(Address.BldgRoom item)` Add a 'BldgRoom' element item.
`void`	`clearAddressLines()` Remove all 'AddressLine' element items.
`void`	`clearBldgRooms()` Remove all 'BldgRoom' element items.
`java.lang.String`	`getAddressLine(int index)` Get 'AddressLine' element item by position.
`java.util.List<java.lang.String>`	`getAddressLines()` Get the list of 'AddressLine' element items.
`Address.BldgRoom`	`getBldgRoom(int index)` Get 'BldgRoom' element item by position.
`java.util.List<Address.BldgRoom>`	`getBldgRooms()` Get the list of 'BldgRoom' element items.
`java.lang.String`	`getCityName()` Get the 'CityName' element value.
`CountryName`	`getCountryName()` Get the 'CountryName' element value.
`java.lang.String`	`getCounty()` Get the 'County' element value.
`java.lang.Boolean`	`getFormattedInd()` Get the 'FormattedInd' attribute value.
`java.lang.String`	`getPostalCode()` Get the 'PostalCode' element value.
`PrivacyGroup`	`getPrivacyGroup()` Get the 'PrivacyGroup' attributeGroup value.
`java.lang.String`	`getRemark()` Get the 'Remark' attribute value.
`StateProv`	`getStateProv()` Get the 'StateProv' element value.
`Address.StreetNmbr`	`getStreetNmbr()` Get the 'StreetNmbr' element value.
`java.lang.String`	`getType()` Get the 'Type' attribute value.
`void`	`setAddressLines(java.util.List<java.lang.String> list)` Set the list of 'AddressLine' element items.
`void`	`setBldgRooms(java.util.List<Address.BldgRoom> list)` Set the list of 'BldgRoom' element items.
`void`	`setCityName(java.lang.String cityName)` Set the 'CityName' element value.
`void`	`setCountryName(CountryName countryName)` Set the 'CountryName' element value.
`void`	`setCounty(java.lang.String county)` Set the 'County' element value.
`void`	`setFormattedInd(java.lang.Boolean formattedInd)` Set the 'FormattedInd' attribute value.
`void`	`setPostalCode(java.lang.String postalCode)` Set the 'PostalCode' element value.
`void`	`setPrivacyGroup(PrivacyGroup privacyGroup)` Set the 'PrivacyGroup' attributeGroup value.
`void`	`setRemark(java.lang.String remark)` Set the 'Remark' attribute value.
`void`	`setStateProv(StateProv stateProv)` Set the 'StateProv' element value.
`void`	`setStreetNmbr(Address.StreetNmbr streetNmbr)` Set the 'StreetNmbr' element value.
`void`	`setType(java.lang.String type)` Set the 'Type' attribute value.
`int`	`sizeAddressLines()` Get the number of 'AddressLine' element items.
`int`	`sizeBldgRooms()` Get the number of 'BldgRoom' element items.

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

Constructor Detail

Address

public Address()

Method Detail

getStreetNmbr

public Address.StreetNmbr getStreetNmbr()

Get the 'StreetNmbr' element value.

Returns:: value

setStreetNmbr

public void setStreetNmbr(Address.StreetNmbr streetNmbr)

Set the 'StreetNmbr' element value.

Parameters:: streetNmbr -

getBldgRooms

public java.util.List<Address.BldgRoom> getBldgRooms()

Get the list of 'BldgRoom' element items.

Returns:: list

setBldgRooms

public void setBldgRooms(java.util.List<Address.BldgRoom> list)

Set the list of 'BldgRoom' element items.

Parameters:: list -

sizeBldgRooms

public int sizeBldgRooms()

Get the number of 'BldgRoom' element items.

Returns:: count

addBldgRoom

public void addBldgRoom(Address.BldgRoom item)

Add a 'BldgRoom' element item.

Parameters:: item -

getBldgRoom

public Address.BldgRoom getBldgRoom(int index)

Get 'BldgRoom' element item by position.

Parameters:: index -
Returns:: item

clearBldgRooms

public void clearBldgRooms()

Remove all 'BldgRoom' element items.

getAddressLines

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

Get the list of 'AddressLine' element items. When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Returns:: list

setAddressLines

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

Set the list of 'AddressLine' element items. When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Parameters:: list -

sizeAddressLines

public int sizeAddressLines()

Get the number of 'AddressLine' element items.

Returns:: count

addAddressLine

public void addAddressLine(java.lang.String item)

Add a 'AddressLine' element item.

Parameters:: item -

getAddressLine

public java.lang.String getAddressLine(int index)

Get 'AddressLine' element item by position.

Parameters:: index -
Returns:: item

clearAddressLines

public void clearAddressLines()

Remove all 'AddressLine' element items.

getCityName

public java.lang.String getCityName()

Get the 'CityName' element value. City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

Returns:: value

setCityName

public void setCityName(java.lang.String cityName)

Set the 'CityName' element value. City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

Parameters:: cityName -

getPostalCode

public java.lang.String getPostalCode()

Get the 'PostalCode' element value. Post Office Code number.

Returns:: value

setPostalCode

public void setPostalCode(java.lang.String postalCode)

Set the 'PostalCode' element value. Post Office Code number.

Parameters:: postalCode -

getCounty

public java.lang.String getCounty()

Get the 'County' element value. County or Region Name (e.g., Fairfax).

Returns:: value

setCounty

public void setCounty(java.lang.String county)

Set the 'County' element value. County or Region Name (e.g., Fairfax).

Parameters:: county -

getStateProv

public StateProv getStateProv()

Get the 'StateProv' element value. State or Province name (e.g., Texas).

Returns:: value

setStateProv

public void setStateProv(StateProv stateProv)

Set the 'StateProv' element value. State or Province name (e.g., Texas).

Parameters:: stateProv -

getCountryName

public CountryName getCountryName()

Get the 'CountryName' element value. Country name (e.g., Ireland).

Returns:: value

setCountryName

public void setCountryName(CountryName countryName)

Set the 'CountryName' element value. Country name (e.g., Ireland).

Parameters:: countryName -

getFormattedInd

public java.lang.Boolean getFormattedInd()

Get the 'FormattedInd' attribute value. Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. false

Returns:: value

setFormattedInd

public void setFormattedInd(java.lang.Boolean formattedInd)

Set the 'FormattedInd' attribute value. Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. false

Parameters:: formattedInd -

getPrivacyGroup

public PrivacyGroup getPrivacyGroup()

Get the 'PrivacyGroup' attributeGroup value. Allows for control of the sharing of address information between parties.

Returns:: value

setPrivacyGroup

public void setPrivacyGroup(PrivacyGroup privacyGroup)

Set the 'PrivacyGroup' attributeGroup value. Allows for control of the sharing of address information between parties.

Parameters:: privacyGroup -

getType

public java.lang.String getType()

Get the 'Type' attribute value. Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).

Returns:: value

setType

public void setType(java.lang.String type)

Set the 'Type' attribute value. Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).

Parameters:: type -

getRemark

public java.lang.String getRemark()

Get the 'Remark' attribute value. A remark associated with this address.

Returns:: value

setRemark

public void setRemark(java.lang.String remark)

Set the 'Remark' attribute value. A remark associated with this address.

Parameters:: remark -