 |
Aspose.Barcode for Python via Java Generation and Recognition API docs
|
Address of creditor or debtor. More...
Inherits _MwWrapper.
Public Member Functions | |
| None | __init__ (self) |
| bool | __eq__ (self, Address other) |
| Determines whether the specified object is equal to the current object. More... | |
| int | __hash__ (self) |
| Returns the hash code for the current instance. More... | |
| Optional[str] | address_line1 (self) |
| Gets the address line 1. More... | |
| None | address_line1 (self, Optional[str] value) |
| Sets the address line 1. More... | |
| Optional[str] | address_line2 (self) |
| Gets the address line 2. More... | |
| None | address_line2 (self, Optional[str] value) |
| Sets the address line 2. More... | |
| None | clear (self) |
| Clears all fields and sets the type to AddressType.Undetermined. More... | |
| Optional[str] | country_code (self) |
| Gets the two-letter ISO country code. More... | |
| None | country_code (self, Optional[str] value) |
| Sets the two-letter ISO country code. More... | |
| Optional[str] | house_no (self) |
| Gets the house number. More... | |
| None | house_no (self, Optional[str] value) |
| Sets the house number. More... | |
| Optional[str] | name (self) |
| Gets the name, either the first and last name of a natural person or the company name of a legal person. More... | |
| None | name (self, Optional[str] value) |
| Sets the name, either the first and last name of a natural person or the company name of a legal person. More... | |
| Optional[str] | postal_code (self) |
| Gets the postal code. More... | |
| None | postal_code (self, Optional[str] value) |
| Sets the postal code. More... | |
| Optional[str] | street (self) |
| Gets the street. More... | |
| None | street (self, Optional[str] value) |
| Sets the street. More... | |
| Optional[str] | town (self) |
| Gets the town or city. More... | |
| None | town (self, Optional[str] value) |
| Sets the town or city. More... | |
| AddressType | type (self) |
Public Attributes | |
| address_line1 | |
| address_line2 | |
| country_code | |
| house_no | |
| name | |
| postal_code | |
| street | |
| town | |
Detailed Description
Address of creditor or debtor.
You can either set street, house number, postal code and town (type structured address) or address line 1 and 2 (type combined address elements). The type is automatically set once any of these fields is set. Before setting the fields, the address type is undetermined. If fields of both types are set, the address type becomes conflicting. Name and country code must always be set unless all fields are empty.
Constructor & Destructor Documentation
◆ __init__()
| None __init__ | ( | self | ) |
Member Function Documentation
◆ __eq__()
| bool __eq__ | ( | self, | |
| Address | other | ||
| ) |
Determines whether the specified object is equal to the current object.
- Returns
- True if the specified object is equal to the current object; otherwise, false.
- Parameters
-
obj The object to compare with the current object.
◆ __hash__()
| int __hash__ | ( | self | ) |
Returns the hash code for the current instance.
- Returns
- A hash code for the current object.
◆ address_line1() [1/2]
| Optional[str] address_line1 | ( | self | ) |
Gets the address line 1.
Address line 1 contains street name, house number or P.O. box. Setting this field sets the address type to AddressType.CombinedElements unless it's already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses and is optional.
- Returns
- :The address line 1.
◆ address_line1() [2/2]
| None address_line1 | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the address line 1.
Address line 1 contains street name, house number or P.O. box. Setting this field sets the address type to AddressType.CombinedElements unless it's already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses and is optional.
- Parameters
-
:The address line 1.
◆ address_line2() [1/2]
| Optional[str] address_line2 | ( | self | ) |
Gets the address line 2.
Address line 2 contains postal code and town. Setting this field sets the address type to AddressType.CombinedElements unless it's already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses. For this type, it's mandatory.
- Returns
- : The address line 2.
◆ address_line2() [2/2]
| None address_line2 | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the address line 2.
Address line 2 contains postal code and town. Setting this field sets the address type to AddressType.CombinedElements unless it's already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses. For this type, it's mandatory.
- Parameters
-
:The address line 2.
◆ clear()
| None clear | ( | self | ) |
Clears all fields and sets the type to AddressType.Undetermined.
◆ country_code() [1/2]
| Optional[str] country_code | ( | self | ) |
Gets the two-letter ISO country code.
The country code is mandatory unless the entire address contains None or emtpy values.
- Returns
- :The ISO country code.
◆ country_code() [2/2]
| None country_code | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the two-letter ISO country code.
The country code is mandatory unless the entire address contains None or emtpy values.
- Parameters
-
:The ISO country code.
◆ house_no() [1/2]
| Optional[str] house_no | ( | self | ) |
Gets the house number.
Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
- Returns
- :The house number.
◆ house_no() [2/2]
| None house_no | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the house number.
Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
- Parameters
-
:The house number.
◆ name() [1/2]
| Optional[str] name | ( | self | ) |
Gets the name, either the first and last name of a natural person or the company name of a legal person.
- Returns
- :The name.
◆ name() [2/2]
| None name | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the name, either the first and last name of a natural person or the company name of a legal person.
- Parameters
-
:The name.
◆ postal_code() [1/2]
| Optional[str] postal_code | ( | self | ) |
Gets the postal code.
Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it's mandatory.
- Returns
- :The postal code.
◆ postal_code() [2/2]
| None postal_code | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the postal code.
Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it's mandatory.
- Parameters
-
:The postal code.
◆ street() [1/2]
| Optional[str] street | ( | self | ) |
Gets the street.
The street must be speicfied without house number. Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
- Returns
- :The street.
◆ street() [2/2]
| None street | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the street.
The street must be speicfied without house number. Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
- Parameters
-
:The street.
◆ town() [1/2]
| Optional[str] town | ( | self | ) |
Gets the town or city.
Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it's mandatory.
- Returns
- :The town or city.
◆ town() [2/2]
| None town | ( | self, | |
| Optional[str] | value | ||
| ) |
Sets the town or city.
Setting this field sets the address type to AddressType.Structured unless it's already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it's mandatory.
- Parameters
-
:The town or city.
◆ type()
| AddressType type | ( | self | ) |
Member Data Documentation
◆ address_line1
| address_line1 |
◆ address_line2
| address_line2 |
◆ country_code
| country_code |
◆ house_no
| house_no |
◆ name
| name |
◆ postal_code
| postal_code |
◆ street
| street |
◆ town
| town |