Aspose.Barcode for Python via Java Generation and Recognition API docs

Address of creditor or debtor. More...

Inherits BaseJavaClass.

Public Member Functions

def __init__ (self, arg)
 
def getType (self)
 Gets the address type. More...
 
def getName (self)
 Gets the name, either the first and last name of a natural person or the company name of a legal person. More...
 
def setName (self, value)
 Sets the name, either the first and last name of a natural person or the company name of a legal person. More...
 
def getAddressLine1 (self)
 Gets the address line 1. More...
 
def setAddressLine1 (self, value)
 Sets the address line 1. More...
 
def getAddressLine2 (self)
 Gets the address line 2. More...
 
def setAddressLine2 (self, value)
 Sets the address line 2. More...
 
def getStreet (self)
 Gets the street. More...
 
def setStreet (self, value)
 Sets the street. More...
 
def getHouseNo (self)
 Gets the house number. More...
 
def setHouseNo (self, value)
 Sets the house number. More...
 
def getPostalCode (self)
 Gets the postal code. More...
 
def setPostalCode (self, value)
 Sets the postal code. More...
 
def getTown (self)
 Gets the town or city. More...
 
def setTown (self, value)
 Sets the town or city. More...
 
def getCountryCode (self)
 Gets the two-letter ISO country code. More...
 
def setCountryCode (self, value)
 Sets the two-letter ISO country code. More...
 
def clear (self)
 Clears all fields and sets the type to AddressType.Undetermined. More...
 
def equals (self, obj)
 Determines whether the specified object is equal to the current object. More...
 
def hashCode (self)
 Gets the hash code for this instance. More...
 
def init (self)
 
- Public Member Functions inherited from BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Static Public Member Functions

def initAddress (arg)
 

Static Public Attributes

string javaClassName = "com.aspose.mw.barcode.complexbarcode.MwAddress"
 

Additional Inherited Members

- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

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__()

def __init__ (   self,
  arg 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ clear()

def clear (   self)

Clears all fields and sets the type to AddressType.Undetermined.

◆ equals()

def equals (   self,
  obj 
)

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
objThe object to compare with the current object.

◆ getAddressLine1()

def getAddressLine1 (   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. @:return:The address line 1.

◆ getAddressLine2()

def getAddressLine2 (   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. @:return: The address line 2.

◆ getCountryCode()

def getCountryCode (   self)

Gets the two-letter ISO country code.

The country code is mandatory unless the entire address contains None or emtpy values. @:return:The ISO country code.

◆ getHouseNo()

def getHouseNo (   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. @:return:The house number.

◆ getName()

def getName (   self)

Gets the name, either the first and last name of a natural person or the company name of a legal person.

@:return:The name.

◆ getPostalCode()

def getPostalCode (   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. @:return:The postal code.

◆ getStreet()

def getStreet (   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. @:return:The street.

◆ getTown()

def getTown (   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. @:return:The town or city.

◆ getType()

def getType (   self)

Gets the address type.

The address type is automatically set by either setting street / house number or address line 1 and 2. Before setting the fields, the address type is Undetermined. If fields of both types are set, the address type becomes Conflicting. @:return: The address type.

◆ hashCode()

def hashCode (   self)

Gets the hash code for this instance.

Returns
A hash code for the current object.

◆ init()

def init (   self)

Reimplemented from BaseJavaClass.

◆ initAddress()

def initAddress (   arg)
static

◆ setAddressLine1()

def setAddressLine1 (   self,
  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. @:param:The address line 1.

◆ setAddressLine2()

def setAddressLine2 (   self,
  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. @:param:The address line 2.

◆ setCountryCode()

def setCountryCode (   self,
  value 
)

Sets the two-letter ISO country code.

The country code is mandatory unless the entire address contains None or emtpy values. @:param:The ISO country code.

◆ setHouseNo()

def setHouseNo (   self,
  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. @:param:The house number.

◆ setName()

def setName (   self,
  value 
)

Sets the name, either the first and last name of a natural person or the company name of a legal person.

@:param:The name.

◆ setPostalCode()

def setPostalCode (   self,
  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. @:param:The postal code.

◆ setStreet()

def setStreet (   self,
  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. @:param:The street.

◆ setTown()

def setTown (   self,
  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. @:param:The town or city.

Member Data Documentation

◆ javaClassName

string javaClassName = "com.aspose.mw.barcode.complexbarcode.MwAddress"
static