atg.integrations.taxware

Class ZipResultItem

java.lang.Object

FieldSet

atg.integrations.taxware.ZipResultItem

public class ZipResultItem
extends FieldSet

The ZipResultItem class represents the result of a request for zip verification information. It defines a few convenience functions for accessing commonly used properties, but allows the generic accessor functions for FieldSet to be used for other properties.

See the verazip documentation for a detailed description of what the various fields mean in practice.

See Also:

ZipRequest, ZipResult, VeraZipCaller, FieldSet, OutputRecordDef

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected static RecordDef	m_recordDef Holds the pointer to our static RecordDef object.

Method Summary

Methods

Modifier and Type	Method and Description
byte	compareItem(ZipResultItem itemCompare) Returns an integer representing which fields differ.
protected void	createRecordDef() Create our recordDef object.
java.lang.String	getCityName() Return the city name.
java.lang.String	getCountyCode() Return the county code.
java.lang.String	getCountyName() Return the county name.
java.lang.String	getFirstZipCode() Return the first zip code.
java.lang.String	getGeoCode() Return the GEOCODE.
java.lang.String	getOutsideCityLimits() The possible return values of this method are..
java.lang.String	getSecondZipCode() Return the second zip code.
java.lang.String	getStateCode() Return the state code.
boolean	isOutsideCityLimits() Deprecated. This method is deprecated use getOutsideCityLimits() The possible values of this field have been extended to include another field, 2, which indicates location is at police jurisdication. But since this method assumes that the field contains only two values, this method has been modified to return false even if the location is at police jurisdication to provide backward compatibility. To use this field use the method getOutsideCityLimits() which gives the accurate result.
static void	main(java.lang.String[] rgArgs) Dump out our fielddefs.
boolean	matchesCityStateZip(java.lang.String pCity, java.lang.String pStateCode, java.lang.String pZip) Return true if pass in City, StateCode and ZIP match the contents of the result item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

m_recordDef

protected static RecordDef m_recordDef

Holds the pointer to our static RecordDef object.

Method Detail

createRecordDef

protected void createRecordDef()

Create our recordDef object.

main

public static void main(java.lang.String[] rgArgs)

Dump out our fielddefs.

getStateCode

public java.lang.String getStateCode()

Return the state code.

getFirstZipCode

public java.lang.String getFirstZipCode()

Return the first zip code.

getSecondZipCode

public java.lang.String getSecondZipCode()

Return the second zip code.

getGeoCode

public java.lang.String getGeoCode()

Return the GEOCODE.

getCityName

public java.lang.String getCityName()

Return the city name.

getCountyCode

public java.lang.String getCountyCode()

Return the county code.

getCountyName

public java.lang.String getCountyName()

Return the county name.

isOutsideCityLimits

public boolean isOutsideCityLimits()

Deprecated. This method is deprecated use getOutsideCityLimits() The possible values of this field have been extended to include another field, 2, which indicates location is at police jurisdication. But since this method assumes that the field contains only two values, this method has been modified to return false even if the location is at police jurisdication to provide backward compatibility. To use this field use the method getOutsideCityLimits() which gives the accurate result.

Return the county code.

getOutsideCityLimits

public java.lang.String getOutsideCityLimits()

The possible return values of this method are.. 0, -- indicating that this location is inside city limit 1, -- indicating that this location is outside city limit 2, -- indicating that this location is at police jurisdiction

compareItem

public byte compareItem(ZipResultItem itemCompare)

Returns an integer representing which fields differ.

matchesCityStateZip

public boolean matchesCityStateZip(java.lang.String pCity,
                          java.lang.String pStateCode,
                          java.lang.String pZip)

Return true if pass in City, StateCode and ZIP match the contents of the result item.