atg.integrations.taxware
Interface VeraZipable

All Known Implementing Classes:

VeraZipOrderImpl

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.

See Also:

OrderImpl, VeraZipOrderImpl, ZipResult, ZipResultItem

Field Summary

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.

Method Summary

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.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

SHIP_TO_ADDRESS_NAME

static final java.lang.String SHIP_TO_ADDRESS_NAME

Ship to address name. Not required, but useful for getZipRequestForAddress() implementations and calls

See Also:

Constant Field Values

BILLING_ADDRESS_NAME

static final java.lang.String BILLING_ADDRESS_NAME

Ship to address name. Not required, but useful for getZipRequestForAddress() implementations and calls

See Also:

Constant Field Values

Method Detail

getMaxCountOfZipAddresses

int getMaxCountOfZipAddresses()

Maximum number of addressed to verify

getZipRequestForAddress

ZipRequest getZipRequestForAddress(int idxAddress)

Create a ZipRequest for the specified address (the address to be verified). If his method returns null, that means that the specified address does not need to be checked.

getIndexForAddressName

int getIndexForAddressName(java.lang.String pAddress)

Get the index for the specified address name. This is kind of tedious, but makes it possible for a non-zip method (like TaxWareCalculateSalesTax) that is interested in Zip info to get the current zip info associated with an address by name, rather than by magic number.

Should return -1 if there is no address by that name.

getAddressNameForIndex

java.lang.String getAddressNameForIndex(int index)

setZipResultAt

void setZipResultAt(int idx,
                    ZipResult pZipResult)

Set the ZipResult for a specified address. This is called by the TaxWareVerifyZipInfo order processing object.

getZipResultAt

ZipResult getZipResultAt(int idx)

Get the zip result at the specified index.

setZipErrorString

void setZipErrorString(java.lang.String pError)

Set the zip error string -- the error string associated with the zip code. There can only be one of these at a time.

getZipErrorString

java.lang.String getZipErrorString()

Get the current zip error string.

setZipError

void setZipError(boolean pIsError)

Set whether a zip error exists. This should probably only be used with a "false" value, since generically seting zip error isn't terribly informative.

isZipError

boolean isZipError()

Return true if the is a zip code error currently on the order.