|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.integrations.taxware.ZipResult
public class ZipResult
The ZipResult class represents the result of a request for zip verification information. It contains, among other things, an array of ZipResultItems.
It also contains an index which represents the user's choice from the array.
See the verazip documentation for a detailed description of what the various fields mean in practice.
ZipRequest
,
ZipResultItem
,
VeraZipCaller
,
FieldSet
,
OutputRecordDef
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
protected byte |
m_flagsVary
A bit verctor representing the fields which vary accross return items. |
protected int |
m_idxChosen
The index of the chosen ZipResultItem. |
protected int |
m_iErrorCode
Error code returned by request |
protected ZipResultItem[] |
m_rgResultItems
Our array of zip result items |
protected java.lang.String |
m_strErrorMessage
Error string returned by request |
Method Summary | |
---|---|
int |
getChosenIndex()
Get the chosen index. |
boolean |
getCitiesVary()
Returns true if city varies amoung the result items. |
boolean |
getCityLimitsVary()
Returns true if city limits vary amoung the result items. |
boolean |
getCountiesVary()
Returns true if county names vary amoung the result items. |
java.lang.String |
getDescriptionAt(int idx)
Returns the description for the item at index idx. |
protected java.lang.String |
getDescriptionForItem(ZipResultItem item)
Generates the string used to describe a given item. |
java.lang.String[] |
getDescriptions()
Returns the array of descriptions. |
int |
getErrorCode()
Returns the error code associated with the ZipResult. |
java.lang.String |
getErrorMessage()
Gets the error message associated with the zip result. |
ZipResultItem |
getResultItemAt(int idx)
Returns the ZipResultItem at the specified index. |
int |
getResultItemCount()
Returns a count of the result items. |
boolean |
getStatesVary()
Returns true if state codes vary amoung the result items. |
boolean |
getZipsVary()
Returns true if FirstZipCode varies amoung the result items. |
boolean |
matchesCityStateZip(java.lang.String strCity,
java.lang.String strState,
java.lang.String strZip)
Returns true if the value stored in this ZipResult matches the specifiers in the ZipRequest passed in. |
boolean |
matchesRequest(ZipRequest zrequest)
Returns true if the value stored in this ZipResult matches the specifiers in the ZipRequest passed in. |
void |
setChosenIndex(int pChosenIndex)
Set the chosen index. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected ZipResultItem[] m_rgResultItems
protected int m_iErrorCode
protected java.lang.String m_strErrorMessage
protected byte m_flagsVary
protected int m_idxChosen
Method Detail |
---|
public ZipResultItem getResultItemAt(int idx)
public java.lang.String[] getDescriptions()
protected java.lang.String getDescriptionForItem(ZipResultItem item)
public java.lang.String getDescriptionAt(int idx)
public int getResultItemCount()
public int getErrorCode()
public java.lang.String getErrorMessage()
public boolean getZipsVary()
public boolean getCitiesVary()
public boolean getCityLimitsVary()
public boolean getCountiesVary()
public boolean getStatesVary()
public boolean matchesRequest(ZipRequest zrequest)
Used to determine if we need to go back to VeraZip to generate a new ZipResult.
public boolean matchesCityStateZip(java.lang.String strCity, java.lang.String strState, java.lang.String strZip)
Used to determine if we need to go back to VeraZip to generate a new ZipResult.
public void setChosenIndex(int pChosenIndex)
public int getChosenIndex()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |