org.broadleafcommerce.core.pricing.service.FulfillmentPricingService 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;
import org.broadleafcommerce.common.vendor.service.exception.FulfillmentPriceException;
import org.broadleafcommerce.core.order.domain.FulfillmentGroup;
import org.broadleafcommerce.core.order.domain.FulfillmentOption;
import org.broadleafcommerce.core.pricing.service.fulfillment.provider.FulfillmentEstimationResponse;
import org.broadleafcommerce.core.pricing.service.fulfillment.provider.FulfillmentPricingProvider;
import org.broadleafcommerce.core.pricing.service.workflow.FulfillmentGroupMerchandiseTotalActivity;
import java.util.List;
import java.util.Set;
/**
* This service can be used in a couple of different ways. First, this is used in the pricing workflow and specifically
* {@link FulfillmentGroupMerchandiseTotalActivity} to calculate costs for {@link FulfillmentGroup}s in an {@link Order}. This can
* also be injected in a controller to provide estimations for various {@link FulfillmentOption}s to display to the user
* before an option is actually selected.
*
* @author Phillip Verheyden
*/
public interface FulfillmentPricingService {
/**
* Called during the Pricing workflow to determine the cost for the {@link FulfillmentGroup}. This will loop through
* {@link #getProcessors()} and call {@link FulfillmentPricingProvider#calculateCostForFulfillmentGroup(FulfillmentGroup)}
* on the first processor that returns true from {@link FulfillmentPricingProvider#canCalculateCostForFulfillmentGroup(FulfillmentGroup)}
*
* @param fulfillmentGroup
* @return the updated fulfillmentGroup with its shippingPrice set
* @throws FulfillmentPriceException if fulfillmentGroup does not have a FulfillmentOption associated to it or
* if there was no processor found to calculate costs for fulfillmentGroup
* @see {@link FulfillmentPricingProvider}
*/
public FulfillmentGroup calculateCostForFulfillmentGroup(FulfillmentGroup fulfillmentGroup) throws FulfillmentPriceException;
/**
* This provides an estimation for a {@link FulfillmentGroup} with a {@link FulfillmentOption}. The main use case for this method
* is in a view cart controller that wants to provide estimations for different {@link FulfillmentOption}s before the user
* actually selects one. This uses {@link #getProviders()} to allow third-party integrations to respond to
* estimations, and returns the first processor that returns true from {@link FulfillmentPricingProvider#canCalculateCostForFulfillmentGroup(FulfillmentGroup, FulfillmentOption)}.
*
* @param fulfillmentGroup
* @param options
* @return the price estimation for a particular {@link FulfillmentGroup} with a candidate {@link FulfillmentOption}
* @throws FulfillmentPriceException if no processor was found to estimate costs for fulfillmentGroup with the given option
* @see {@link FulfillmentPricingProvider}
*/
public FulfillmentEstimationResponse estimateCostForFulfillmentGroup(FulfillmentGroup fulfillmentGroup, Set options) throws FulfillmentPriceException;
public List getProviders();
}