org.broadleafcommerce.core.order.domain.TaxDetail 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.order.domain;
import org.broadleafcommerce.common.config.domain.ModuleConfiguration;
import org.broadleafcommerce.common.currency.domain.BroadleafCurrency;
import org.broadleafcommerce.common.money.Money;
import java.io.Serializable;
import java.math.BigDecimal;
/**
* The Interface TaxDetail. A TaxDetail object stores relevant tax information
* including a tax type, amount, and rate.
*
*/
public interface TaxDetail extends Serializable {
/**
* Gets the id.
*
* @return the id
*/
public Long getId();
/**
* Sets the id.
*
* @param id the new id
*/
public void setId(Long id);
/**
* Gets the tax type
*
* @return the tax type
*/
public TaxType getType();
/**
* Sets the tax type
*
* @param type the tax type
*/
public void setType(TaxType type);
/**
* Gets the tax amount
*
* @return the tax amount
*/
public Money getAmount();
/**
* Sets the tax amount
*
* @param amount the tax amount
*/
public void setAmount(Money amount);
/**
* Gets the tax rate
*
* @return the rate
*/
public BigDecimal getRate();
/**
* Sets the tax rate.
*
* @param name the tax rate
*/
public void setRate(BigDecimal rate);
public BroadleafCurrency getCurrency();
public void setCurrency(BroadleafCurrency currency);
/**
* Returns the configuration of the module that was used to calculate taxes. Allows
* for tracking, especially when more than one module may be used by the system.
* @return
*/
public ModuleConfiguration getModuleConfiguration();
/**
* Sets the module configuration that was used to calculate taxes. Allows for tracking
* of which module was used, especially in cases where more than one module is available
* over time.
* @param config
*/
public void setModuleConfiguration(ModuleConfiguration config);
/**
* Optionally sets the name of the tax jurisdiction.
* @param jurisdiction
*/
public void setJurisdictionName(String jurisdiction);
/**
* Returns the name of the tax jurisdiction. May return null.
* @return
*/
public String getJurisdictionName();
/**
* Sets the name of the tax, if applicable.
* @param taxName
*/
public void setTaxName(String taxName);
/**
* Gets the name of the tax. May return null.
* @return
*/
public String getTaxName();
/**
* Sets the region, as a string. Typically this will be a
* State, Province, or County.
* @param region
*/
public void setRegion(String region);
/**
* Returns the name of the region used for tax calculation. May
* return null.
* @return
*/
public String getRegion();
/**
* Sets the country used for tax calculation.
* @param country
*/
public void setCountry(String country);
/**
* Returns the country, as a string, used for tax calculation.
* May return null.
* @return
*/
public String getCountry();
}