ePages 7.27.0 - DE_EPAGES/Tax/API/Object/TaxMethod.pm

Package DE_EPAGES::Tax::API::Object::TaxMethod

object interface for TaxMethod.

Base
DE_EPAGES::Shop::API::Object::ShopObject

Functions

IsMethodDirectlyUsable
disablePaymentSplit
disableShippingSplit
featureName
isDefaultTaxType
isPaymentTaxable
isShippingTaxable
showTaxAreaSelectionForBasket
showTaxModelSelectionForCustomer
taxMatrix
updateContainerTaxArea
usableAtStorefront

IsMethodDirectlyUsable

Returns true if TaxMethod directly usable in the shop without further configuration.

Syntax
my $IsUsable = $Package->isMethodDirectlyUsable($Shop);
Input
$Shop (object)
shop
Return
$IsUsable (boolean)
Method can be used

disablePaymentSplit

True if payment tax spliting is disabled.

Syntax
$Disable = $TaxMethod->disablePaymentSplit;
Return
$Disable (boolean)
true or false

disableShippingSplit

True if shipping tax spliting is disabled.

Syntax
$Disable = $TaxMethod->disableShippingSplit;
Return
$Disable (boolean)
true or false

featureName

Returns the feature name.

Syntax
$FeatureName = $TaxMethod->featureName;
Return
$FeatureName (String)
feature name (undef means no feature count)

isDefaultTaxType

True if tax method is now the default tax type for the shop.

Syntax
$ShowSelection = $TaxMethod->isDefaultTaxType;
Return
$IsDefaultTaxType (boolean)
true or false

isPaymentTaxable

True if payment is taxable.

Syntax
$Taxable = $TaxMethod->isPaymentTaxable;
Return
$Taxable (boolean)
true or false

isShippingTaxable

True if shipping is taxable.

Syntax
$Taxable = $TaxMethod->isShippingTaxable;
Return
$Taxable (boolean)
true or false

showTaxAreaSelectionForBasket

True if tax area selection can be enabled for the Basket.

Syntax
$ShowSelection = $TaxMethod->showTaxAreaSelectionForBasket;
Return
$ShowSelection (boolean)
true or false

showTaxModelSelectionForCustomer

True if tax method selection for customer is usable in MBO.

Syntax
$ShowSelection = $TaxMethod->showTaxModelSelectionForCustomer;
Return
$ShowSelection (boolean)
true or false

taxMatrix

Returns the tax matrix.

Syntax
$FeatureName = $TaxMethod->taxMatrix;
Return
$TaxMatrix (Object)
tax matrix

updateContainerTaxArea

Updates the container taxarea.

Syntax
$IsUpdated = $TaxMethod->updateContainerTaxArea;
Input
$Container (object)
LineitemContainer
Return
$IsUpdated (boolean)
1 if active

usableAtStorefront

Tests if a tax method is visible in the storefront. Should be overwritten by tax method subclasses.

Syntax
$Usable = $TaxMethod->usableAtStorefront($hVars);
Input
$hVars (ref.hash)
input vars currently no attributes used.
Return
$Usable (boolean)
true if tax method is usable in the storefront