OASISAddress Class Reference
Constructors
Instance Methods
- getAdministrativeArea() ⇒
String - getCountryCode() ⇒
String - getCountryName() ⇒
String - getLocality() ⇒
String - getPostalCode() ⇒
String - getSubAdministrativeArea() ⇒
String - getSubLocality() ⇒
String - getSubThoroughfare() ⇒
String - getThoroughfare() ⇒
String - setAdministrativeArea(area) ⇒
OASISAddress - setCountryCode(code) ⇒
OASISAddress - setCountryName(name) ⇒
OASISAddress - setLocality(locality) ⇒
OASISAddress - setPostalCode(code) ⇒
OASISAddress - setSubAdministrativeArea(area) ⇒
OASISAddress - setSubLocality(locality) ⇒
OASISAddress - setSubThoroughfare(thoroughfare) ⇒
OASISAddress - setThoroughfare(thoroughfare) ⇒
OASISAddress
Instance Methods
oASISAddress.getAdministrativeArea() ⇒ String
Get the AdministrativeArea
Kind: Instance method of OASISAddress
Returns: String - the KEY_ADMINISTRATIVE_AREA value
oASISAddress.getCountryCode() ⇒ String
Get the CountryCode
Kind: Instance method of OASISAddress
Returns: String - the KEY_COUNTRY_CODE value
oASISAddress.getCountryName() ⇒ String
Get the CountryName
Kind: Instance method of OASISAddress
Returns: String - the KEY_COUNTRY_NAME value
oASISAddress.getLocality() ⇒ String
Get the Locality
Kind: Instance method of OASISAddress
Returns: String - the KEY_LOCALITY value
oASISAddress.getPostalCode() ⇒ String
Get the PostalCode
Kind: Instance method of OASISAddress
Returns: String - the KEY_POSTAL_CODE value
oASISAddress.getSubAdministrativeArea() ⇒ String
Get the SubAdministrativeArea
Kind: Instance method of OASISAddress
Returns: String - the KEY_SUB_ADMINISTRATIVE_AREA value
oASISAddress.getSubLocality() ⇒ String
Get the SubLocality
Kind: Instance method of OASISAddress
Returns: String - the KEY_SUB_LOCALITY value
oASISAddress.getSubThoroughfare() ⇒ String
Get the SubThoroughfare
Kind: Instance method of OASISAddress
Returns: String - the KEY_SUB_THOROUGHFARE value
oASISAddress.getThoroughfare() ⇒ String
Get the Thoroughfare
Kind: Instance method of OASISAddress
Returns: String - the KEY_THOROUGHFARE value
oASISAddress.setAdministrativeArea(area) ⇒ OASISAddress
Set the AdministrativeArea
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| area | String |
Portion of country (e.g. state) - The desired AdministrativeArea. {'string_min_length': 0, 'string_max_length': 200} |
oASISAddress.setCountryCode(code) ⇒ OASISAddress
Set the CountryCode
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| code | String |
Name of country (ISO 3166-2) - The desired CountryCode. {'string_min_length': 0, 'string_max_length': 50} |
oASISAddress.setCountryName(name) ⇒ OASISAddress
Set the CountryName
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
Name of the country (localized) - The desired CountryName. {'string_min_length': 0, 'string_max_length': 200} |
oASISAddress.setLocality(locality) ⇒ OASISAddress
Set the Locality
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| locality | String |
Hypernym for e.g. city/village - The desired Locality. {'string_min_length': 0, 'string_max_length': 200} |
oASISAddress.setPostalCode(code) ⇒ OASISAddress
Set the PostalCode
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| code | String |
(PLZ, ZIP, PIN, CAP etc.) - The desired PostalCode. {'string_min_length': 0, 'string_max_length': 16} |
oASISAddress.setSubAdministrativeArea(area) ⇒ OASISAddress
Set the SubAdministrativeArea
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| area | String |
Portion of e.g. state (e.g. county) - The desired SubAdministrativeArea. {'string_min_length': 0, 'string_max_length': 200} |
oASISAddress.setSubLocality(locality) ⇒ OASISAddress
Set the SubLocality
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| locality | String |
Hypernym for e.g. district - The desired SubLocality. {'string_min_length': 0, 'string_max_length': 200} |
oASISAddress.setSubThoroughfare(thoroughfare) ⇒ OASISAddress
Set the SubThoroughfare
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| thoroughfare | String |
Portion of thoroughfare e.g. house number - The desired SubThoroughfare. {'string_min_length': 0, 'string_max_length': 200} |
oASISAddress.setThoroughfare(thoroughfare) ⇒ OASISAddress
Set the Thoroughfare
Kind: Instance method of OASISAddress
Returns: OASISAddress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| thoroughfare | String |
Hypernym for street, road etc. - The desired Thoroughfare. {'string_min_length': 0, 'string_max_length': 200} |