com.konakart.appif

Interface ShippingQuoteIf

All Known Implementing Classes:

ShippingQuote

public interface ShippingQuoteIf

An order may have a ShippingQuote object to describe the shipping. This object is generated by a shipping module.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() The code of the shipping module.
java.math.BigDecimal	getCost()
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
java.lang.String	getDescription() The shipping module description to put on the UI so that it can be selected.
java.math.BigDecimal	getFreeShippingOver() The value for freeShippingOver is set in a configuration variable.
java.math.BigDecimal	getHandlingCost()
java.lang.String	getIcon()
java.lang.String	getModuleCode() The code of the shipping module.
ShippingQuoteIf[]	getQuotes()
java.lang.String	getResponseText() The response text that can be used in the UI.
java.lang.String	getShippingServiceCode()
int	getSortOrder() Defines the order in which the shipping modules are displayed.
java.math.BigDecimal	getTax()
int	getTaxClass()
java.math.BigDecimal	getTaxRate()
java.lang.String	getTitle() The title of the shipping module which can be used in the UI.
java.math.BigDecimal	getTotalExTax()
java.math.BigDecimal	getTotalIncTax()
boolean	isFree() If set to true, the shipping is free.
void	setCode(java.lang.String code) The code of the shipping module.
void	setCost(java.math.BigDecimal cost)
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
void	setDescription(java.lang.String description) The shipping module description to put on the UI so that it can be selected.
void	setFree(boolean free) If set to true, the shipping is free.
void	setFreeShippingOver(java.math.BigDecimal freeShippingOver) The value for freeShippingOver is set in a configuration variable.
void	setHandlingCost(java.math.BigDecimal handlingCost)
void	setIcon(java.lang.String icon)
void	setModuleCode(java.lang.String moduleCode) The code of the shipping module.
void	setQuotes(ShippingQuoteIf[] quotes)
void	setResponseText(java.lang.String responseText) The response text that can be used in the UI.
void	setShippingServiceCode(java.lang.String shippingServiceCode)
void	setSortOrder(int sortOrder) Defines the order in which the shipping modules are displayed.
void	setTax(java.math.BigDecimal tax)
void	setTaxClass(int taxClass)
void	setTaxRate(java.math.BigDecimal taxRate)
void	setTitle(java.lang.String title) The title of the shipping module which can be used in the UI.
void	setTotalExTax(java.math.BigDecimal totalExTax)
void	setTotalIncTax(java.math.BigDecimal totalIncTax)

Method Detail

getCode

java.lang.String getCode()

The code of the shipping module. e.g. flat, free, table etc. This can have "_n" appended to it (where n is an integer) to ensure uniqueness amongst a set of shipping quotes.

Returns:

Returns the code.

setCode

void setCode(java.lang.String code)

The code of the shipping module. e.g. flat, free, table etc. This can have "_n" appended to it (where n is an integer) to ensure uniqueness amongst a set of shipping quotes.

Parameters:

code - The code to set.

getModuleCode

java.lang.String getModuleCode()

The code of the shipping module. e.g. flat, free, table etc. This is always just the module code without any "_n" appended as in the code attribute.

Returns:

Returns the code.

setModuleCode

void setModuleCode(java.lang.String moduleCode)

The code of the shipping module. e.g. flat, free, table etc. This is always just the module code without any "_n" appended as in the code attribute.

Parameters:

moduleCode - The code to set.

getDescription

java.lang.String getDescription()

The shipping module description to put on the UI so that it can be selected.

Returns:

Returns the description.

setDescription

void setDescription(java.lang.String description)

The shipping module description to put on the UI so that it can be selected.

Parameters:

description - The description to set.

getIcon

java.lang.String getIcon()

Returns:

Returns the icon.

setIcon

void setIcon(java.lang.String icon)

Parameters:

icon - The icon to set.

getSortOrder

int getSortOrder()

Defines the order in which the shipping modules are displayed.

Returns:

Returns the sortOrder.

setSortOrder

void setSortOrder(int sortOrder)

Defines the order in which the shipping modules are displayed.

Parameters:

sortOrder - The sortOrder to set.

getTitle

java.lang.String getTitle()

The title of the shipping module which can be used in the UI.

Returns:

Returns the title.

setTitle

void setTitle(java.lang.String title)

The title of the shipping module which can be used in the UI.

Parameters:

title - The title to set.

getHandlingCost

java.math.BigDecimal getHandlingCost()

Returns:

Returns the handlingCost.

setHandlingCost

void setHandlingCost(java.math.BigDecimal handlingCost)

Parameters:

handlingCost - The handlingCost to set.

getTax

java.math.BigDecimal getTax()

Returns:

Returns the tax.

setTax

void setTax(java.math.BigDecimal tax)

Parameters:

tax - The tax to set.

getResponseText

java.lang.String getResponseText()

The response text that can be used in the UI.

Returns:

Returns the responseText.

setResponseText

void setResponseText(java.lang.String responseText)

The response text that can be used in the UI.

Parameters:

responseText - The responseText to set.

getCost

java.math.BigDecimal getCost()

Returns:

Returns the cost.

setCost

void setCost(java.math.BigDecimal cost)

Parameters:

cost - The cost to set.

isFree

boolean isFree()

If set to true, the shipping is free.

Returns:

Returns the free.

setFree

void setFree(boolean free)

If set to true, the shipping is free.

Parameters:

free - The free to set.

getFreeShippingOver

java.math.BigDecimal getFreeShippingOver()

The value for freeShippingOver is set in a configuration variable.

Returns:

Returns the freeShippingOver.

setFreeShippingOver

void setFreeShippingOver(java.math.BigDecimal freeShippingOver)

The value for freeShippingOver is set in a configuration variable.

Parameters:

freeShippingOver - The freeShippingOver to set.

getTaxClass

int getTaxClass()

Returns:

Returns the taxClass.

setTaxClass

void setTaxClass(int taxClass)

Parameters:

taxClass - The taxClass to set.

getTaxRate

java.math.BigDecimal getTaxRate()

Returns:

the taxRate

setTaxRate

void setTaxRate(java.math.BigDecimal taxRate)

Parameters:

taxRate - the taxRate to set

getTotalExTax

java.math.BigDecimal getTotalExTax()

Returns:

Returns the totalExTax.

setTotalExTax

void setTotalExTax(java.math.BigDecimal totalExTax)

Parameters:

totalExTax - The totalExTax to set.

getTotalIncTax

java.math.BigDecimal getTotalIncTax()

Returns:

Returns the totalIncTax.

setTotalIncTax

void setTotalIncTax(java.math.BigDecimal totalIncTax)

Parameters:

totalIncTax - The totalIncTax to set.

getQuotes

ShippingQuoteIf[] getQuotes()

Returns:

Returns the quotes.

setQuotes

void setQuotes(ShippingQuoteIf[] quotes)

Parameters:

quotes - The quotes to set.

getShippingServiceCode

java.lang.String getShippingServiceCode()

Returns:

the shippingServiceCode

setShippingServiceCode

void setShippingServiceCode(java.lang.String shippingServiceCode)

Parameters:

shippingServiceCode - the shippingServiceCode to set

getCustom1

java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - The custom5 to set.