org.broadleafcommerce.core.pricing.service.tax.provider.TaxProvider Maven / Gradle / Ivy
/*
* #%L
* BroadleafCommerce Framework
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.broadleafcommerce.core.pricing.service.tax.provider;
import org.broadleafcommerce.common.config.domain.ModuleConfiguration;
import org.broadleafcommerce.common.config.service.ModuleProvider;
import org.broadleafcommerce.core.order.domain.Order;
import org.broadleafcommerce.core.pricing.service.exception.TaxException;
/**
*
*
* @author Phillip Verheyden (phillipuniverse)
*/
public interface TaxProvider extends ModuleProvider {
/**
* Calculates taxes on an entire order. Returns the order with taxes included.
* @param order
* @param config
* @return
*/
public Order calculateTaxForOrder(Order order, ModuleConfiguration config) throws TaxException;
/**
* This method provides the implementation an opportunity to finalize taxes on the order. This is
* often required when tax sub systems require tax documents to be created on checkout. This method
* will typically be called by the checkout workflow, rather than by the pricing workflow. Some implementations
* may wish to do nothing in this method, except perhaps recalculate taxes.
*
* @param order
* @param config
* @return
* @throws TaxException
*/
public Order commitTaxForOrder(Order order, ModuleConfiguration config) throws TaxException;
/**
* Some tax providers store tax details from an order on an external system for reporting and tax reconcilliation.
* This allows one to cancel or undo tax recording in an external system. Typically, this will be called to offset
* a call to commitTaxForOrder. This might be called, for example, in a rollback handler for a checkout workflow activity
* that calls commitTaxForOrder. Many implementations may wish to do nothing in this method.
*
* @param order
* @param config
* @throws TaxException
*/
public void cancelTax(Order order, ModuleConfiguration config) throws TaxException;
}