public class CostCenterManager extends GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected static CostCenterManager |
mCostCenterManager |
protected static java.util.ResourceBundle |
sResourceBundle
Resource Bundle
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
CostCenterManager()
Constructs an CostCenterManager object.
|
Modifier and Type | Method and Description |
---|---|
CostCenter |
addCostCenterToOrder(Order pOrder,
CostCenter pCostCenter)
Adds the given cost center to the given order.
|
void |
addItemAmountToCostCenter(Order pOrder,
java.lang.String pCommerceItemId,
java.lang.String pCostCenterId,
double pAmount)
Adds the given amount of the CommerceItem with the given id to the CostCenter with
the given id.
|
void |
addItemQuantityToCostCenter(Order pOrder,
java.lang.String pCommerceItemId,
java.lang.String pCostCenterId,
long pQuantity)
Adds the given quantity of the CommerceItem with the given id to the CostCenter with
the given id.
|
void |
addOrderAmountToCostCenter(Order pOrder,
java.lang.String pCostCenterId,
double pAmount)
Adds the given amount of the Order's cost to the CostCenter with the given id.
|
void |
addRemainingItemAmountToCostCenter(Order pOrder,
java.lang.String pCommerceItemId,
java.lang.String pCostCenterId)
Adds any unassigned amount of the CommerceItem with the given id to the CostCenter with
the given id.
|
void |
addRemainingItemQuantityToCostCenter(Order pOrder,
java.lang.String pCommerceItemId,
java.lang.String pCostCenterId)
Adds any unassigned quantity of the CommerceItem with the given id to the CostCenter with
the given id.
|
void |
addRemainingOrderAmountToCostCenter(Order pOrder,
java.lang.String pCostCenterId)
Adds any unassigned amount of the Order's cost to the CostCenter with the given id.
|
void |
addRemainingShippingCostToCostCenter(Order pOrder,
java.lang.String pShippingGroupId,
java.lang.String pCostCenterId)
Adds any unassigned amount of the ShippingGroup's cost with the given id to the CostCenter with
the given id.
|
void |
addRemainingTaxAmountToCostCenter(Order pOrder,
java.lang.String pCostCenterId)
Adds any unassigned amount of the Order's tax to the CostCenter with the given id.
|
void |
addShippingCostAmountToCostCenter(Order pOrder,
java.lang.String pShippingGroupId,
java.lang.String pCostCenterId,
double pAmount)
Adds the given amount of the ShippingGroup's cost with the given id to the CostCenter with
the given id.
|
void |
addTaxAmountToCostCenter(Order pOrder,
java.lang.String pCostCenterId,
double pAmount)
Adds the given amount of the Order's tax to the CostCenter with the given id.
|
CostCenter |
createCostCenter(java.lang.String pIdentifier)
Creates a new CostCenter object using the default type specified in the OrderTools defaultCostCenterType
property.
|
CostCenter |
createCostCenter(java.lang.String pCostCenterType,
java.lang.String pIdentifier)
Creates a new CostCenter object using the class mapped to the given name in pCostCenterType.
|
protected Relationship |
createRelationship(java.lang.String pRelationshipType)
Creates a new Relationship object using the class type mapped to the type supplied in
pShippingGroupType.
|
CostCenter |
getCostCenterByIdentifier(java.util.List pCostCenters,
java.lang.String pIdentifier)
This method will return a CostCenter whose identifier is pIdentifier.
|
CostCenterCommerceItemRelationship |
getCostCenterCommerceItemRelationship(Order pOrder,
java.lang.String pCommerceItemId,
java.lang.String pCostCenterId)
Returns the relationship object which exists between the given CommerceItem and CostCenter.
|
static CostCenterManager |
getCostCenterManager() |
CostCenterOrderRelationship |
getCostCenterOrderRelationship(Order pOrder,
java.lang.String pCostCenterId)
Returns the relationship object which exists between the given Order and CostCenter.
|
CostCenterShippingGroupRelationship |
getCostCenterShippingGroupRelationship(Order pOrder,
java.lang.String pCostCenterId,
java.lang.String pShippingGroupId)
Returns the relationship object which exists between the given ShippingGroup and CostCenter.
|
int |
getOrderCount(java.lang.String pCostCenterId,
java.lang.String[] pStates,
java.util.Collection<java.lang.String> pSiteIds)
Returns a count of the orders for a given cost center id
|
java.util.List |
getOrderIdsForCostCenter(java.lang.String pCostCenterId,
int pStartIndex,
int pNumOrders)
Returns the order ids for the given cost center with the given constraints.
|
java.util.List |
getOrderIdsForCostCenter(java.lang.String pCostCenterId,
int pStartIndex,
int pNumOrders,
java.lang.String[] pStates,
java.lang.String pSortProperty,
boolean pAscending,
java.util.Collection<java.lang.String> pSiteIds)
Returns the order ids for the given cost center id with the given constraints and sorting options.
|
OrderManager |
getOrderManager()
Returns the OrderManager
|
java.util.List |
getOrdersForCostCenter(java.lang.String pCostCenterId,
int pStartIndex,
int pNumOrders)
Returns all the orders for the given cost center id with the given constraints.
|
java.util.List |
getOrdersForCostCenter(java.lang.String pCostCenterId,
int pStartIndex,
int pNumOrders,
java.lang.String[] pStates,
java.lang.String pSortProperty,
boolean pAscending,
java.util.Collection<java.lang.String> pSiteIds)
Returns the orders for the given cost center id with the given constraints and sorting options.
|
OrderTools |
getOrderTools()
Returns the OrderTools
|
double |
getRemainingAmountForCostCenter(CommerceItem pItem)
Calculate the "amount remaining" for a given item.
|
long |
getRemainingQuantityForCostCenter(CommerceItem pItem)
Calculate the "quantity remaining" for a given item.
|
double |
getUnassignedAmountForCommerceItem(CommerceItem pItem)
This method returns the unassigned amount for a CommerceItem.
|
long |
getUnassignedQuantityForCommerceItem(CommerceItem pItem)
This method returns the unassigned quantity for a CommerceItem.
|
void |
moveItemToCostCenter(Order pOrder,
CommerceItem pCommerceItem,
long pQuantity,
CostCenter pSrcCostCenter,
CostCenter pDestCostCenter)
This method moves an item from one CostCenter to another.
|
void |
moveItemToCostCenter(Order pOrder,
java.lang.String pCatalogRefId,
long pQuantity,
java.lang.String pSrcCostCenterId,
java.lang.String pDestCostCenterId)
This method moves an item from one CostCenter to another.
|
PipelineResult |
recalculateCostCenterAmounts(Order pOrder)
Recalculates the amounts for each CostCenter supplied in pCostCenterList.
|
void |
removeAllCostCentersFromOrder(Order pOrder)
Removes all the CostCenters and their Relationships from an Order.
|
void |
removeAllRelationshipsFromCostCenter(Order pOrder,
java.lang.String pCostCenterId)
Removes all the relationships from the CostCenter with the given id in the given order.
|
void |
removeCostCenterFromOrder(Order pOrder,
java.lang.String pCostCenterId)
Removes the given CostCenter from the given order.
|
void |
removeItemQuantityFromCostCenter(Order pOrder,
java.lang.String pCommerceItemId,
java.lang.String pCostCenterId,
long pQuantity)
Removes the given quantity of the CommerceItem with the given id from the CostCenter with
the given id.
|
void |
setOrderManager(OrderManager pOrderManager)
Sets the OrderManager
|
void |
setOrderTools(OrderTools pOrderTools)
Sets the OrderTools
|
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected static java.util.ResourceBundle sResourceBundle
protected static CostCenterManager mCostCenterManager
public CostCenterManager()
public static CostCenterManager getCostCenterManager()
public OrderManager getOrderManager()
public void setOrderManager(OrderManager pOrderManager)
public OrderTools getOrderTools()
public void setOrderTools(OrderTools pOrderTools)
public CostCenter createCostCenter(java.lang.String pIdentifier) throws CommerceException
InvalidParameterException
- thrown if any of the parameters are nullObjectCreationException
- if the instantiation of an object failsCommerceException
OrderTools.getDefaultCostCenterType()
public CostCenter createCostCenter(java.lang.String pCostCenterType, java.lang.String pIdentifier) throws CommerceException
pCostCenterType
- the name that is mapped in the OrderTools.properties file to the class of
the desired type to createpIdentifier
- the user-defined name of the CostCenterInvalidParameterException
- thrown if any of the parameters are nullObjectCreationException
- if the instantiation of an object failsCommerceException
public CostCenter addCostCenterToOrder(Order pOrder, CostCenter pCostCenter) throws CommerceException
pOrder
- the Order to add the CommerceItem topCostCenter
- the CostCenter to add to the OrderInvalidParameterException
- thrown if any of the parameters are nullCommerceException
public void removeCostCenterFromOrder(Order pOrder, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order to remove the CostCenter frompCostCenterId
- the id of the CostCenter to remove from the OrderInvalidParameterException
- thrown if any of the parameters are nullCostCenterNotFoundException
- if a CostCenter with the given id is not found in the given orderObjectRemovalException
- thrown if the CostCenter contains any relationshipsCommerceException
public void removeAllCostCentersFromOrder(Order pOrder) throws CommerceException
pOrder
- the Order which contains the CostCenters to be removedInvalidParameterException
- thrown if any of the parameters are nullObjectRemovalException
- thrown if a CostCenter cannot be removedCommerceException
public void removeAllRelationshipsFromCostCenter(Order pOrder, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which contains the CostCenter to remove the relationships frompCostCenterId
- the id of the CostCenterInvalidParameterException
- thrown if any of the parameters are nullCostCenterNotFoundException
- if a CostCenter with the given id is not found in the given orderObjectRemovalException
- thrown if a relationship cannot be removedCommerceException
public CostCenter getCostCenterByIdentifier(java.util.List pCostCenters, java.lang.String pIdentifier) throws CommerceException
pCostCenters
- a List of CostCenterspIdentifier
- the identifier to search for in the List of CostCentersInvalidParameterException
- if any of the parameters are nullCommerceException
public CostCenterCommerceItemRelationship getCostCenterCommerceItemRelationship(Order pOrder, java.lang.String pCommerceItemId, java.lang.String pCostCenterId) throws CommerceException
pCommerceItemId
- the id of the CommerceItem which makes up a half of the relationshippCostCenterId
- the id of the CostCenter which makes up a half of the relationshipInvalidParameterException
- thrown if any of the parameters are nullRelationshipNotFoundException
- if a relationship is not foundCommerceException
public CostCenterOrderRelationship getCostCenterOrderRelationship(Order pOrder, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which makes up half of the relationshippCostCenterId
- the id of the CostCenter which makes up a half of the relationshipInvalidParameterException
- thrown if any of the parameters are nullRelationshipNotFoundException
- if a relationship is not foundCommerceException
public CostCenterShippingGroupRelationship getCostCenterShippingGroupRelationship(Order pOrder, java.lang.String pCostCenterId, java.lang.String pShippingGroupId) throws CommerceException
pShippingGroupId
- the id of the ShippingGroup which makes up a half of the relationshippCostCenterId
- the id of the CostCenter which makes up a half of the relationshipInvalidParameterException
- thrown if any of the parameters are nullRelationshipNotFoundException
- if a relationship is not foundCommerceException
public void moveItemToCostCenter(Order pOrder, java.lang.String pCatalogRefId, long pQuantity, java.lang.String pSrcCostCenterId, java.lang.String pDestCostCenterId) throws CommerceException
pOrder
- the order which the item exists inpCatalogRefId
- the catalogRefId of the item to movepQuantity
- the quantity to movepSrcCostCenterId
- the id of the costCenter to move the item frompDestCostCenterId
- the id of the costCenter to move the item toCommerceException
- thrown if the operation could not be completed. More information
can be found within the exception.public void moveItemToCostCenter(Order pOrder, CommerceItem pCommerceItem, long pQuantity, CostCenter pSrcCostCenter, CostCenter pDestCostCenter) throws CommerceException
pOrder
- the order which the item exists inpCommerceItem
- the commerce item to movepQuantity
- the quantity to movepSrcCostCenter
- the costCenter to move the item frompDestCostCenter
- the costCenter to move the item toCommerceException
- thrown if the operation could not be completed. More information
can be found within the exception.public void removeItemQuantityFromCostCenter(Order pOrder, java.lang.String pCommerceItemId, java.lang.String pCostCenterId, long pQuantity) throws CommerceException
pOrder
- the Order which the CommerceItem and CostCenter existpCommerceItemId
- the id of the CommerceItem to to remove from the CostCenterpCostCenterId
- the id of the CostCenter which the CommerceItem will be removed frompQuantity
- the quantity of the CommerceItem which will be removedInvalidParameterException
- thrown if any of the parameters are nullObjectRemovalException
- if the removal of the quantity failsCommerceException
public void addItemQuantityToCostCenter(Order pOrder, java.lang.String pCommerceItemId, java.lang.String pCostCenterId, long pQuantity) throws CommerceException
pOrder
- the Order which the CommerceItem and CostCenter existpCommerceItemId
- the id of the CommerceItem to addpCostCenterId
- the id of the CostCenter which the CommerceItem will be added topQuantity
- the quantity of the CommerceItem which will be addedInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterCommerceItemRelationship
public void addRemainingItemQuantityToCostCenter(Order pOrder, java.lang.String pCommerceItemId, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which the CommerceItem and CostCenter existpCommerceItemId
- the id of the CommerceItem to addpCostCenterId
- the id of the CostCenter which the CommerceItem will be added toInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterCommerceItemRelationship
public void addItemAmountToCostCenter(Order pOrder, java.lang.String pCommerceItemId, java.lang.String pCostCenterId, double pAmount) throws CommerceException
pOrder
- the Order which the CommerceItem and CostCenter existpCommerceItemId
- the id of the CommerceItem to addpCostCenterId
- the id of the CostCenter which the CommerceItem will be added topAmount
- the amount of the CommerceItem which will be addedInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterCommerceItemRelationship
public void addRemainingItemAmountToCostCenter(Order pOrder, java.lang.String pCommerceItemId, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which the CommerceItem and CostCenter existpCommerceItemId
- the id of the CommerceItem to addpCostCenterId
- the id of the CostCenter which the CommerceItem will be added toInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterCommerceItemRelationship
public long getUnassignedQuantityForCommerceItem(CommerceItem pItem)
pItem
- the CommerceItem we are checkinggetRemainingQuantityForCostCenter(CommerceItem)
public long getRemainingQuantityForCostCenter(CommerceItem pItem)
pItem
- The CommerceItem we are checkingpublic double getUnassignedAmountForCommerceItem(CommerceItem pItem)
pItem
- the CommerceItem we are checkinggetRemainingAmountForCostCenter(CommerceItem)
public double getRemainingAmountForCostCenter(CommerceItem pItem)
pItem
- The CommerceItem we are checkingpublic void addShippingCostAmountToCostCenter(Order pOrder, java.lang.String pShippingGroupId, java.lang.String pCostCenterId, double pAmount) throws CommerceException
pOrder
- the Order which the CostCenter and ShippingGroup existpShippingGroupId
- the id of the ShippingGroup's cost to addpCostCenterId
- the id of the CostCenter which the ShippingGroup's cost will be added topAmount
- the amount that is assigned for payment to the CostCenterInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterShippingGroupRelationship
public void addRemainingShippingCostToCostCenter(Order pOrder, java.lang.String pShippingGroupId, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which the CostCenter and ShippingGroup existpShippingGroupId
- the id of the ShippingGroup's cost to addpCostCenterId
- the id of the CostCenter which the ShippingGroup's cost will be added toInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterShippingGroupRelationship
public void addTaxAmountToCostCenter(Order pOrder, java.lang.String pCostCenterId, double pAmount) throws CommerceException
pOrder
- the Order which the CostCenter existspCostCenterId
- the id of the CostCenter which the Order's tax will be added topAmount
- the amount that is assigned for payment to the CostCenterInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterOrderRelationship
public void addRemainingTaxAmountToCostCenter(Order pOrder, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which the PaymentGroup existspCostCenterId
- the id of the CostCenter which the Order's tax will be added toInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterOrderRelationship
public void addOrderAmountToCostCenter(Order pOrder, java.lang.String pCostCenterId, double pAmount) throws CommerceException
pOrder
- the Order which the CostCenter existspCostCenterId
- the id of the CostCenter which the Order's cost will be added topAmount
- the amount that is assigned for payment to the CostCenterInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterOrderRelationship
public void addRemainingOrderAmountToCostCenter(Order pOrder, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order which the CostCenter existspCostCenterId
- the id of the CostCenter which the Order's cost will be added toInvalidParameterException
- thrown if any of the parameters are nullInvalidTypeException
- thrown if more than one REMAINING relationship type is added to a CostCenter
or if an invalid type is set to the RelationshipObjectCreationException
- if the instantiation of an object failsCommerceException
CostCenterOrderRelationship
public PipelineResult recalculateCostCenterAmounts(Order pOrder) throws CommerceException
pOrder
- the Order to recalculate the CostCenters inCommerceException
- thrown if an error occurs while recalculating the amountspublic java.util.List getOrdersForCostCenter(java.lang.String pCostCenterId, int pStartIndex, int pNumOrders) throws CommerceException
pCostCenterId
- the CostCenter idpStartIndex
- The index of the first order to returnpNumOrders
- The number of orders to returnInvalidParameterException
- thrown if any of the parameters are null or empty stringCommerceException
- thrown if an exception occurs while accessing the repositorypublic java.util.List getOrdersForCostCenter(java.lang.String pCostCenterId, int pStartIndex, int pNumOrders, java.lang.String[] pStates, java.lang.String pSortProperty, boolean pAscending, java.util.Collection<java.lang.String> pSiteIds) throws CommerceException
pCostCenterId
- the CostCenter idpStartIndex
- The index of the first order to returnpNumOrders
- The number of orders to returnpStates
- If provided, results will be filtered by the provided statespSortProperty
- The property to sort the results bypAscending
- Whether to return the results in ascending or decending orderpSiteIds
- Results will be filtered by the given site IdsInvalidParameterException
- thrown if any of the parameters are null or empty stringCommerceException
- thrown if an exception occurs while accessing the repositorypublic java.util.List getOrderIdsForCostCenter(java.lang.String pCostCenterId, int pStartIndex, int pNumOrders) throws CommerceException
pCostCenterId
- the CostCenter idpStartIndex
- The index of the first order to returnpNumOrders
- The number of orders to returnInvalidParameterException
- thrown if any of the parameters are null or empty stringCommerceException
- thrown if an exception occurs while accessing the repositorypublic java.util.List getOrderIdsForCostCenter(java.lang.String pCostCenterId, int pStartIndex, int pNumOrders, java.lang.String[] pStates, java.lang.String pSortProperty, boolean pAscending, java.util.Collection<java.lang.String> pSiteIds) throws CommerceException
pCostCenterId
- the CostCenter idpStartIndex
- The index of the first order to returnpNumOrders
- The number of orders to returnpStates
- If provided, results will be filtered by the provided statespSortProperty
- The property to sort the results bypAscending
- Whether to return the results in ascending or decending orderpSiteIds
- Results will be filtered by the given site IdsInvalidParameterException
- thrown if any of the parameters are null or empty stringCommerceException
- thrown if an exception occurs while accessing the repositorypublic int getOrderCount(java.lang.String pCostCenterId, java.lang.String[] pStates, java.util.Collection<java.lang.String> pSiteIds) throws CommerceException
pCostCenterId
- The cost center idpStates
- Order states to filter the results bypSiteIds
- SiteIds to filter the results byCommerceException
protected Relationship createRelationship(java.lang.String pRelationshipType) throws CommerceException
pRelationshipType
- the type that is mapped in the OrderTools.properties file to the class of
the desired type to createObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the given type is not validInvalidParameterException
- thrown if any of the parameters are nullCommerceException