public interface VeraZipable
This inteface exists to support storing verazip information on the order.
Since any given order could have any number of addresses associated with it, we have a conception of an array of addresses. Each address array index should support storing a ZipResult associated with the address.
Note that the ZipResult stored at each index could have one or more ZipResultItems associated with it.
OrderImpl
,
VeraZipOrderImpl
,
ZipResult
,
ZipResultItem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BILLING_ADDRESS_NAME
Ship to address name.
|
static java.lang.String |
CLASS_VERSION |
static java.lang.String |
SHIP_TO_ADDRESS_NAME
Ship to address name.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAddressNameForIndex(int index) |
int |
getIndexForAddressName(java.lang.String pAddress)
Get the index for the specified address name.
|
int |
getMaxCountOfZipAddresses()
Maximum number of addressed to verify
|
java.lang.String |
getZipErrorString()
Get the current zip error string.
|
ZipRequest |
getZipRequestForAddress(int idxAddress)
Create a ZipRequest for the specified address (the address to be
verified).
|
ZipResult |
getZipResultAt(int idx)
Get the zip result at the specified index.
|
boolean |
isZipError()
Return true if the is a zip code error currently on the order.
|
void |
setZipError(boolean pIsError)
Set whether a zip error exists.
|
void |
setZipErrorString(java.lang.String pError)
Set the zip error string -- the error string associated
with the zip code.
|
void |
setZipResultAt(int idx,
ZipResult pZipResult)
Set the ZipResult for a specified address.
|
static final java.lang.String CLASS_VERSION
static final java.lang.String SHIP_TO_ADDRESS_NAME
static final java.lang.String BILLING_ADDRESS_NAME
int getMaxCountOfZipAddresses()
ZipRequest getZipRequestForAddress(int idxAddress)
int getIndexForAddressName(java.lang.String pAddress)
Should return -1 if there is no address by that name.
java.lang.String getAddressNameForIndex(int index)
void setZipResultAt(int idx, ZipResult pZipResult)
ZipResult getZipResultAt(int idx)
void setZipErrorString(java.lang.String pError)
java.lang.String getZipErrorString()
void setZipError(boolean pIsError)
boolean isZipError()