uniserv.ws.post
Class EnhancedAddress

java.lang.Object
  extended by uniserv.ws.post.EnhancedAddress
All Implemented Interfaces:
java.io.Serializable

public class EnhancedAddress
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
EnhancedAddress()
           
 
Method Summary
 java.lang.String getCity()
           
 java.lang.String getCityDistrict()
           
 java.lang.String getCoordinateLevel()
           
 java.lang.String getCountry()
           
 java.lang.String getErrorMsg()
           
 java.lang.String getHnoMatch()
           
 java.lang.String getLine1()
           
 java.lang.String getLine2()
           
 java.lang.String getLine3()
           
 java.lang.String getLine4()
           
 java.lang.String getLine5()
           
 java.lang.String getLine6()
           
 java.lang.String getMvalCity()
           
 java.lang.String getMvalStreet()
           
 java.lang.String getPoBoxCity()
           
 java.lang.String getPoBoxCountry()
           
 java.lang.String getPoBoxNumber()
           
 java.lang.String getPoBoxZip()
           
 java.lang.String getRegion()
           
 java.lang.String getResCity()
           
 java.lang.String getResCityDistrict()
           
 java.lang.String getResHno()
           
 java.lang.String getResPoBoxCity()
           
 java.lang.String getResPoBoxNumber()
           
 java.lang.String getResPoBoxZip()
           
 java.lang.String getResRegion()
           
 java.lang.String getResSpecCity()
           
 java.lang.String getResSpecZip()
           
 java.lang.String getResStreet()
           
 int getResultClass()
           
 int getResultCoordinateClass()
           
 int getResultPoBoxClass()
           
 int getResultSpecClass()
           
 java.lang.String getResZip()
           
 java.lang.String getSpecCity()
           
 java.lang.String getSpecCountry()
           
 java.lang.String getSpecZip()
           
 java.lang.String getStreet()
           
 java.lang.String getXCoordinate()
           
 java.lang.String getYCoordinate()
           
 java.lang.String getZip()
           
 void setCity(java.lang.String city)
          Don't use this method!
To set input data use the class InputAddress
 void setCityDistrict(java.lang.String cityDistrict)
          Don't use this method!
To set input data use the class InputAddress
 void setCoordinateLevel(java.lang.String coordinateLevel)
          Don't use this method!
 void setCountry(java.lang.String country)
          Don't use this method!
To set input data use the class InputAddress
 void setErrorMsg(java.lang.String c)
          Don't use this method!
 void setHnoMatch(java.lang.String hnoMatch)
          Don't use this method!
 void setLine1(java.lang.String line1)
          Don't use this method!
To set input data use the class InputAddress
 void setLine2(java.lang.String line2)
          Don't use this method!
To set input data use the class InputAddress
 void setLine3(java.lang.String line3)
          Don't use this method!
To set input data use the class InputAddress
 void setLine4(java.lang.String line4)
          Don't use this method!
To set input data use the class InputAddress
 void setLine5(java.lang.String line5)
          Don't use this method!
To set input data use the class InputAddress
 void setLine6(java.lang.String line6)
          Don't use this method!
To set input data use the class InputAddress
 void setMvalCity(java.lang.String mvalCity)
          Don't use this method!
 void setMvalStreet(java.lang.String mvalStreet)
          Don't use this method!
 void setPoBoxCity(java.lang.String poBoxCity)
          Don't use this method!
To set input data use the class InputAddress
 void setPoBoxCountry(java.lang.String poBoxCountry)
          Don't use this method!
To set input data use the class InputAddress
 void setPoBoxNumber(java.lang.String poBoxNumber)
          Don't use this method!
To set input data use the class InputAddress
 void setPoBoxZip(java.lang.String poBoxZip)
          Don't use this method!
To set input data use the class InputAddress
 void setRegion(java.lang.String region)
          Don't use this method!
To set input data use the class InputAddress
 void setResCity(java.lang.String resCity)
          Don't use this method!
 void setResCityDistrict(java.lang.String resCityDistrict)
          Don't use this method!
 void setResHno(java.lang.String resHno)
          Don't use this method!
 void setResPoBoxCity(java.lang.String resPoBoxCity)
          Don't use this method!
 void setResPoBoxNumber(java.lang.String resPoBoxNumber)
          Don't use this method!
 void setResPoBoxZip(java.lang.String resPoBoxZip)
          Don't use this method!
 void setResRegion(java.lang.String resRegion)
          Don't use this method!
 void setResSpecCity(java.lang.String resSpecCity)
          Don't use this method!
 void setResSpecZip(java.lang.String resSpecZip)
          Don't use this method!
 void setResStreet(java.lang.String resStreet)
          Don't use this method!
 void setResultClass(int rc)
          Don't use this method!
 void setResultCoordinateClass(int resultCoordinateClass)
          Don't use this method!
 void setResultPoBoxClass(int resultPoBoxClass)
          Don't use this method!
 void setResultSpecClass(int resultSpecClass)
          Don't use this method!
 void setResZip(java.lang.String resZip)
          Don't use this method!
 void setSpecCity(java.lang.String specCity)
          Don't use this method!
To set input data use the class InputAddress
 void setSpecCountry(java.lang.String specCountry)
          Don't use this method!
To set input data use the class InputAddress
 void setSpecZip(java.lang.String specZip)
          Don't use this method!
To set input data use the class InputAddress
 void setStreet(java.lang.String street)
          Don't use this method!
To set input data use the class InputAddress
 void setXCoordinate(java.lang.String coordinate)
          Don't use this method!
 void setYCoordinate(java.lang.String coordinate)
          Don't use this method!
 void setZip(java.lang.String zip)
          Don't use this method!
To set input data use the class InputAddress
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnhancedAddress

public EnhancedAddress()
Method Detail

getCountry

public java.lang.String getCountry()
Returns:
Returns the country.
Valid for delivery, po box and special address

getCity

public java.lang.String getCity()
Returns:
Returns the city.
Valid for delivery address

getZip

public java.lang.String getZip()
Returns:
Returns the zip.
Valid for delivery address

getStreet

public java.lang.String getStreet()
Returns:
Returns the street.
Valid for delivery address

getLine1

public java.lang.String getLine1()
Returns:
Returns the line1.
Available only for delivery address entered in line input mode

getLine2

public java.lang.String getLine2()
Returns:
Returns the line2.
Available only for delivery address entered in line input mode

getLine3

public java.lang.String getLine3()
Returns:
Returns the line3.
Available only for delivery address entered in line input mode

getLine4

public java.lang.String getLine4()
Returns:
Returns the line4.
Available only for delivery address entered in line input mode

getLine5

public java.lang.String getLine5()
Returns:
Returns the line5.
Available only for delivery address entered in line input mode

getLine6

public java.lang.String getLine6()
Returns:
Returns the line6.
Available only for delivery address entered in line input mode

getErrorMsg

public java.lang.String getErrorMsg()
Returns:
Returns the errorMsg.
errorMsg contains the description of the failure or warning

getResultClass

public int getResultClass()
Returns:
Returns the resultClass.
resultClass informs about the state of the delivery address.
Possible values:
  • 0 - delivery address was not checked and therefore not available
  • 1 - address found with cerainty, not changed
  • 2 - address found with certainty, changed
  • 3 - address found with uncertainty, changed. However such address is deliverable.
  • 5 - insufficient information or address not found

setResultClass

public void setResultClass(int rc)
Don't use this method!


setErrorMsg

public void setErrorMsg(java.lang.String c)
Don't use this method!


setCountry

public void setCountry(java.lang.String country)
Don't use this method!
To set input data use the class InputAddress


setCity

public void setCity(java.lang.String city)
Don't use this method!
To set input data use the class InputAddress


setZip

public void setZip(java.lang.String zip)
Don't use this method!
To set input data use the class InputAddress


setStreet

public void setStreet(java.lang.String street)
Don't use this method!
To set input data use the class InputAddress


setLine1

public void setLine1(java.lang.String line1)
Don't use this method!
To set input data use the class InputAddress


setLine2

public void setLine2(java.lang.String line2)
Don't use this method!
To set input data use the class InputAddress


setLine3

public void setLine3(java.lang.String line3)
Don't use this method!
To set input data use the class InputAddress


setLine4

public void setLine4(java.lang.String line4)
Don't use this method!
To set input data use the class InputAddress


setLine5

public void setLine5(java.lang.String line5)
Don't use this method!
To set input data use the class InputAddress


setLine6

public void setLine6(java.lang.String line6)
Don't use this method!
To set input data use the class InputAddress


getPoBoxCity

public java.lang.String getPoBoxCity()
Returns:
Returns the poBoxCity.

setPoBoxCity

public void setPoBoxCity(java.lang.String poBoxCity)
Don't use this method!
To set input data use the class InputAddress


getPoBoxCountry

public java.lang.String getPoBoxCountry()
Returns:
Returns the poBoxCountry.

setPoBoxCountry

public void setPoBoxCountry(java.lang.String poBoxCountry)
Don't use this method!
To set input data use the class InputAddress


getPoBoxNumber

public java.lang.String getPoBoxNumber()
Returns:
Returns the poBoxNumber.

setPoBoxNumber

public void setPoBoxNumber(java.lang.String poBoxNumber)
Don't use this method!
To set input data use the class InputAddress


getPoBoxZip

public java.lang.String getPoBoxZip()
Returns:
Returns the poBoxZip.

setPoBoxZip

public void setPoBoxZip(java.lang.String poBoxZip)
Don't use this method!
To set input data use the class InputAddress


getResCity

public java.lang.String getResCity()
Returns:
Returns the resCity. This label indicates the result of the validation on the city.
Possible values:
  • OK - input was correct
  • NI - no entry
  • C - the town was changed
  • SC - the town was found through the archive town or it was restructured
  • NF - not found

setResCity

public void setResCity(java.lang.String resCity)
Don't use this method!


getResCityDistrict

public java.lang.String getResCityDistrict()
Returns:
Returns the resCityDistrict. This label indicates the result of the validation on the cityDistrict.
Possible values:
  • OK - input was correct
  • NI - no entry
  • C - the city district was changed

setResCityDistrict

public void setResCityDistrict(java.lang.String resCityDistrict)
Don't use this method!


getResHno

public java.lang.String getResHno()
Returns:
Returns the resHno. This label indicates the result of the validation on the house number.
Possible values:
  • OK - input was correct
  • NI - no entry
  • NF - not found
  • NC - the house number was not checked
  • HR - the house number is a house range

setResHno

public void setResHno(java.lang.String resHno)
Don't use this method!


getResPoBoxCity

public java.lang.String getResPoBoxCity()
Returns:
Returns the resPoBoxCity.

setResPoBoxCity

public void setResPoBoxCity(java.lang.String resPoBoxCity)
Don't use this method!


getResPoBoxNumber

public java.lang.String getResPoBoxNumber()
Returns:
Returns the resPoBoxNumber. This label indicates the result of the validation on the po box number.
Possible values:
  • OK - po box information correct
  • PL - for this city po box number need to be present
  • PW - po box number invalid
  • CW - this town has no po boxes
  • ZL - po box postal code required
  • ' '- no po box validation was run

setResPoBoxNumber

public void setResPoBoxNumber(java.lang.String resPoBoxNumber)
Don't use this method!


getResPoBoxZip

public java.lang.String getResPoBoxZip()
Returns:
Returns the resPoBoxZip.

setResPoBoxZip

public void setResPoBoxZip(java.lang.String resPoBoxZip)
Don't use this method!


getResRegion

public java.lang.String getResRegion()
Returns:
Returns the resRegion. This label indicates the result of the validation on the region.
Possible values:
  • OK - input was correct
  • NI - no entry
  • C - the region was changed

setResRegion

public void setResRegion(java.lang.String resRegion)
Don't use this method!


getResSpecCity

public java.lang.String getResSpecCity()
Returns:
Returns the resSpecCity.

setResSpecCity

public void setResSpecCity(java.lang.String resSpecCity)
Don't use this method!


getResSpecZip

public java.lang.String getResSpecZip()
Returns:
Returns the resSpecZip.

setResSpecZip

public void setResSpecZip(java.lang.String resSpecZip)
Don't use this method!


getResStreet

public java.lang.String getResStreet()
Returns:
Returns the resStreet. This label indicates the result of the validation on the street.
Possible values:
  • OK - input was correct
  • NI - no entry
  • C - the street was changed
  • SC - the street was restructured
  • NF - not found
  • NC - the street was not checked
  • NP - the street was not checked due to PO BOX details in the street field
  • NR - poste restante not checked

setResStreet

public void setResStreet(java.lang.String resStreet)
Don't use this method!


getResultPoBoxClass

public int getResultPoBoxClass()
Returns:
Returns the resultPoBoxClass.
resultClass informs about the state of the po box address.
Possible values:
  • 0 - po box address was not checked and therefore not available
  • 1 - address found with cerainty, not changed
  • 2 - address found with certainty, changed
  • 3 - address found with uncertainty, changed. However such address is deliverable.
  • 5 - address not found

setResultPoBoxClass

public void setResultPoBoxClass(int resultPoBoxClass)
Don't use this method!


getResultSpecClass

public int getResultSpecClass()
Returns:
Returns the resultSpecClass.
resultSpecClass informs about the state of the special address.
Possible values:
  • 0 - special address was not checked and therefore not available
  • 1 - address found with cerainty, not changed
  • 2 - address found with certainty, changed
  • 3 - address found with uncertainty, changed. However such address is deliverable.
  • 5 - address not found

setResultSpecClass

public void setResultSpecClass(int resultSpecClass)
Don't use this method!


getResZip

public java.lang.String getResZip()
Returns:
Returns the resZip. This label indicates the result of the validation on the postal code.
Possible values:
  • OK - input was correct
  • NI - no entry
  • C - the postal code was changed
  • SC - the first two positions of the postal code were changed
  • NF - not found
  • DF - default postal code
  • PI - only the parts of the postal code were entered

setResZip

public void setResZip(java.lang.String resZip)
Don't use this method!


getSpecCity

public java.lang.String getSpecCity()
Returns:
Returns the specCity.

setSpecCity

public void setSpecCity(java.lang.String specCity)
Don't use this method!
To set input data use the class InputAddress


getSpecCountry

public java.lang.String getSpecCountry()
Returns:
Returns the specCountry.

setSpecCountry

public void setSpecCountry(java.lang.String specCountry)
Don't use this method!
To set input data use the class InputAddress


getSpecZip

public java.lang.String getSpecZip()
Returns:
Returns the specZip.

setSpecZip

public void setSpecZip(java.lang.String specZip)
Don't use this method!
To set input data use the class InputAddress


getCityDistrict

public java.lang.String getCityDistrict()
Returns:
Returns the cityDistrict.

setCityDistrict

public void setCityDistrict(java.lang.String cityDistrict)
Don't use this method!
To set input data use the class InputAddress


getRegion

public java.lang.String getRegion()
Returns:
Returns the region.

setRegion

public void setRegion(java.lang.String region)
Don't use this method!
To set input data use the class InputAddress


getMvalCity

public java.lang.String getMvalCity()
Returns:
Returns the mvalCity.

setMvalCity

public void setMvalCity(java.lang.String mvalCity)
Don't use this method!


getMvalStreet

public java.lang.String getMvalStreet()
Returns:
Returns the mvalStreet.

setMvalStreet

public void setMvalStreet(java.lang.String mvalStreet)
Don't use this method!


getCoordinateLevel

public java.lang.String getCoordinateLevel()
Returns:
Returns the coordinateLevel. Level for which the coordinates are valid:
  • 5 - Town
  • 4 - Entire street
  • 3 - Street section
  • 2 - Single house number

setCoordinateLevel

public void setCoordinateLevel(java.lang.String coordinateLevel)
Don't use this method!


getResultCoordinateClass

public int getResultCoordinateClass()
Returns:
Returns the resultCoordinateClass. *
resultCoordinateClass informs about the state of the coordinates.
Possible values:
  • 0 - coordinates are not available
  • 1 - coordinates are assigned with certainty
  • 2 - coordinates are assigned with certainty, address was changed
  • 3 - default coordinates are assigned. See also CoordinateLevel.
  • 5 - coordinates are not assigned

setResultCoordinateClass

public void setResultCoordinateClass(int resultCoordinateClass)
Don't use this method!


getXCoordinate

public java.lang.String getXCoordinate()
Returns:
Returns the xCoordinate. The 9 characters do mean:
+GGGNNNNNN or
-GGGNNNNNN
with GGG as full degrees and NNNNNN as decimal parts of a degree. If the last 'N' is not available in the raw data of the country, we will set it to '0'.
Example:
48?43'30"
would be in deciaml
48,725
would be coded as
+04872500

setXCoordinate

public void setXCoordinate(java.lang.String coordinate)
Don't use this method!


getYCoordinate

public java.lang.String getYCoordinate()
Returns:
Returns the yCoordinate. * The 9 characters do mean:
+GGGNNNNNN or
-GGGNNNNNN
with GGG as full degrees and NNNNNN as decimal parts of a degree. If the last 'N' is not available in the raw data of the country, we will set it to '0'.
Example:
48?43'30"
would be in deciaml
48,725
would be coded as
+04872500

setYCoordinate

public void setYCoordinate(java.lang.String coordinate)
Don't use this method!


getHnoMatch

public java.lang.String getHnoMatch()
Returns:
Returns the hnoMatch. Label for house number validation. Valid only when house number validation is enabled.
Possible values:
  • OK - house number exists
  • NF - house number does not exist
  • NC - not checked

Default value: NC

setHnoMatch

public void setHnoMatch(java.lang.String hnoMatch)
Don't use this method!