com.konakart.app
Class ShippingQuote

java.lang.Object
  com.konakart.app.ShippingQuote

All Implemented Interfaces:

ShippingQuoteIf

public class ShippingQuote
extends java.lang.Object
implements ShippingQuoteIf

The object used by the engine to receive information from the modules

Constructor Summary

ShippingQuote()

Method Summary

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.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	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)
java.lang.String	toString() Returns a string containing the attributes of the ShippingDescription object

Methods inherited from class java.lang.Object

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

Constructor Detail

ShippingQuote

public ShippingQuote()

Method Detail

toString

public java.lang.String toString()

Returns a string containing the attributes of the ShippingDescription object

Overrides:

toString in class java.lang.Object

getCode

public java.lang.String getCode()

Description copied from interface: ShippingQuoteIf

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

Specified by:

getCode in interface ShippingQuoteIf

Returns:

Returns the code.

setCode

public void setCode(java.lang.String code)

Description copied from interface: ShippingQuoteIf

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

Specified by:

setCode in interface ShippingQuoteIf

Parameters:

code - The code to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: ShippingQuoteIf

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

Specified by:

getDescription in interface ShippingQuoteIf

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: ShippingQuoteIf

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

Specified by:

setDescription in interface ShippingQuoteIf

Parameters:

description - The description to set.

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface ShippingQuoteIf

Returns:

Returns the icon.

setIcon

public void setIcon(java.lang.String icon)

Specified by:

setIcon in interface ShippingQuoteIf

Parameters:

icon - The icon to set.

getSortOrder

public int getSortOrder()

Description copied from interface: ShippingQuoteIf

Defines the order in which the shipping modules are displayed.

Specified by:

getSortOrder in interface ShippingQuoteIf

Returns:

Returns the sortOrder.

setSortOrder

public void setSortOrder(int sortOrder)

Description copied from interface: ShippingQuoteIf

Defines the order in which the shipping modules are displayed.

Specified by:

setSortOrder in interface ShippingQuoteIf

Parameters:

sortOrder - The sortOrder to set.

getTitle

public java.lang.String getTitle()

Description copied from interface: ShippingQuoteIf

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

Specified by:

getTitle in interface ShippingQuoteIf

Returns:

Returns the title.

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: ShippingQuoteIf

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

Specified by:

setTitle in interface ShippingQuoteIf

Parameters:

title - The title to set.

getHandlingCost

public java.math.BigDecimal getHandlingCost()

Specified by:

getHandlingCost in interface ShippingQuoteIf

Returns:

Returns the handlingCost.

setHandlingCost

public void setHandlingCost(java.math.BigDecimal handlingCost)

Specified by:

setHandlingCost in interface ShippingQuoteIf

Parameters:

handlingCost - The handlingCost to set.

getTax

public java.math.BigDecimal getTax()

Specified by:

getTax in interface ShippingQuoteIf

Returns:

Returns the tax.

setTax

public void setTax(java.math.BigDecimal tax)

Specified by:

setTax in interface ShippingQuoteIf

Parameters:

tax - The tax to set.

getResponseText

public java.lang.String getResponseText()

Description copied from interface: ShippingQuoteIf

The response text that can be used in the UI.

Specified by:

getResponseText in interface ShippingQuoteIf

Returns:

Returns the responseText.

setResponseText

public void setResponseText(java.lang.String responseText)

Description copied from interface: ShippingQuoteIf

The response text that can be used in the UI.

Specified by:

setResponseText in interface ShippingQuoteIf

Parameters:

responseText - The responseText to set.

getCost

public java.math.BigDecimal getCost()

Specified by:

getCost in interface ShippingQuoteIf

Returns:

Returns the cost.

setCost

public void setCost(java.math.BigDecimal cost)

Specified by:

setCost in interface ShippingQuoteIf

Parameters:

cost - The cost to set.

isFree

public boolean isFree()

Description copied from interface: ShippingQuoteIf

If set to true, the shipping is free.

Specified by:

isFree in interface ShippingQuoteIf

Returns:

Returns the free.

setFree

public void setFree(boolean free)

Description copied from interface: ShippingQuoteIf

If set to true, the shipping is free.

Specified by:

setFree in interface ShippingQuoteIf

Parameters:

free - The free to set.

getFreeShippingOver

public java.math.BigDecimal getFreeShippingOver()

Description copied from interface: ShippingQuoteIf

The value for freeShippingOver is set in a configuration variable.

Specified by:

getFreeShippingOver in interface ShippingQuoteIf

Returns:

Returns the freeShippingOver.

setFreeShippingOver

public void setFreeShippingOver(java.math.BigDecimal freeShippingOver)

Description copied from interface: ShippingQuoteIf

The value for freeShippingOver is set in a configuration variable.

Specified by:

setFreeShippingOver in interface ShippingQuoteIf

Parameters:

freeShippingOver - The freeShippingOver to set.

getTaxClass

public int getTaxClass()

Specified by:

getTaxClass in interface ShippingQuoteIf

Returns:

Returns the taxClass.

setTaxClass

public void setTaxClass(int taxClass)

Specified by:

setTaxClass in interface ShippingQuoteIf

Parameters:

taxClass - The taxClass to set.

getTotalExTax

public java.math.BigDecimal getTotalExTax()

Specified by:

getTotalExTax in interface ShippingQuoteIf

Returns:

Returns the totalExTax.

setTotalExTax

public void setTotalExTax(java.math.BigDecimal totalExTax)

Specified by:

setTotalExTax in interface ShippingQuoteIf

Parameters:

totalExTax - The totalExTax to set.

getTotalIncTax

public java.math.BigDecimal getTotalIncTax()

Specified by:

getTotalIncTax in interface ShippingQuoteIf

Returns:

Returns the totalIncTax.

setTotalIncTax

public void setTotalIncTax(java.math.BigDecimal totalIncTax)

Specified by:

setTotalIncTax in interface ShippingQuoteIf

Parameters:

totalIncTax - The totalIncTax to set.

getQuotes

public ShippingQuoteIf[] getQuotes()

Specified by:

getQuotes in interface ShippingQuoteIf

Returns:

Returns the quotes.

setQuotes

public void setQuotes(ShippingQuoteIf[] quotes)

Specified by:

setQuotes in interface ShippingQuoteIf

Parameters:

quotes - The quotes to set.

getCustom1

public java.lang.String getCustom1()

Specified by:

getCustom1 in interface ShippingQuoteIf

Returns:

Returns the custom1.

setCustom1

public void setCustom1(java.lang.String custom1)

Specified by:

setCustom1 in interface ShippingQuoteIf

Parameters:

custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()

Specified by:

getCustom2 in interface ShippingQuoteIf

Returns:

Returns the custom2.

setCustom2

public void setCustom2(java.lang.String custom2)

Specified by:

setCustom2 in interface ShippingQuoteIf

Parameters:

custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()

Specified by:

getCustom3 in interface ShippingQuoteIf

Returns:

Returns the custom3.

setCustom3

public void setCustom3(java.lang.String custom3)

Specified by:

setCustom3 in interface ShippingQuoteIf

Parameters:

custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()

Specified by:

getCustom4 in interface ShippingQuoteIf

Returns:

Returns the custom4.

setCustom4

public void setCustom4(java.lang.String custom4)

Specified by:

setCustom4 in interface ShippingQuoteIf

Parameters:

custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()

Specified by:

getCustom5 in interface ShippingQuoteIf

Returns:

Returns the custom5.

setCustom5

public void setCustom5(java.lang.String custom5)

Specified by:

setCustom5 in interface ShippingQuoteIf

Parameters:

custom5 - The custom5 to set.

getShippingServiceCode

public java.lang.String getShippingServiceCode()

Specified by:

getShippingServiceCode in interface ShippingQuoteIf

Returns:

the shippingServiceCode

setShippingServiceCode

public void setShippingServiceCode(java.lang.String shippingServiceCode)

Specified by:

setShippingServiceCode in interface ShippingQuoteIf

Parameters:

shippingServiceCode - the shippingServiceCode to set

getModuleCode

public java.lang.String getModuleCode()

Description copied from interface: ShippingQuoteIf

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.

Specified by:

getModuleCode in interface ShippingQuoteIf

Returns:

the moduleCode

setModuleCode

public void setModuleCode(java.lang.String moduleCode)

Description copied from interface: ShippingQuoteIf

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.

Specified by:

setModuleCode in interface ShippingQuoteIf

Parameters:

moduleCode - the moduleCode to set