public class CostCenterDroplet extends DynamoServlet implements atg.commerce.order.CostCenterConstants
The CostCenterDroplet
is a DynamoServlet that is used to initialize
CostCenters and CommerceIdentifierCostCenter objects for use by the CostCenterFormHandler.
the CostCenterDroplet is composed of the following containers:
CostCenterMapContainer - container for the user's named CostCenters
CommerceIdentifierCostCenterContainer - container for the user's CommerceIdentifierCostCenter objects for a particular Order's CommerceIdentifiers
The service method ensures the following:
CostCenter initialization - the user's CostCenters are created and added to the CostCenterMapContainer. Once this is done the user can begin to select from these during the checkout process.
CommerceIdentifierCostCenter initialization - the Order CommerceIdentifiers of interest are used to instantiate CommerceIdentifierCostCenter objects, and these are added to the CommerceIdentifierCostCenterContainer.
A complete description of the parameters to the CostCenterDroplet are:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
protected java.lang.String |
mInitializeCostCenterIdentifier |
protected static java.util.ResourceBundle |
sResourceBundle
Resource Bundle
|
mAllowCleanupRequest, mParameters
SERVLET_INFO_KEY
SERVICE_INFO_KEY
CICC_MAP, CLEAR_ALL, CLEAR_COST_CENTER_CONTAINER, CLEAR_COST_CENTER_MAP, COST_CENTERS, INIT_CC, INIT_ITEM_COSTCENTERS, INIT_ORDER_COSTCENTERS, INIT_SHIPPING_COSTCENTERS, INIT_TAX_COSTCENTERS, LOAD_COSTCENTERS, MSG_INVALID_SPLIT_QUANTITY, ONE_COST_CENTER, ORDER, OUTPUT, USE_AMOUNT
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
CostCenterDroplet()
Creates a new
CostCenterDroplet instance. |
Modifier and Type | Method and Description |
---|---|
protected void |
consolidateCommerceIdentifierCostCenters(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
consolidateCommerceIdentifierCostCenters consolidates CommerceIdentifierCostCenters
by ensuring there is no redundant data. |
CommerceIdentifierCostCenterContainer |
getCommerceIdentifierCostCenterContainer()
Return the CommerceIdentifierCostCenterContainer property.
|
CostCenterManager |
getCostCenterManager()
Return the CostCenterManager property.
|
CostCenterMapContainer |
getCostCenterMapContainer()
Return the CostCenterMapContainer property.
|
java.lang.String |
getCostCentersPropertyName()
Return the CostCentersPropertyName property.
|
CostCenter |
getDefaultCostCenter()
The
getDefaultCostCenterName method returns the default CostCenter
based on the CostCenterMapContainer's default CostCenter name. |
java.lang.String |
getDefaultCostCenterPropertyName()
Return the DefaultCostCenterPropertyName property.
|
java.lang.String |
getInitializeCostCenterIdentifier()
Returns the cost center identifier that was created by
initializeCostCenters and assigned
as the cost center name to all the CommerceIdentifierCostCenter objects when they were first initialized. |
Order |
getOrder()
Overriding getOrder to use the getOrderFromId property
Return the Order property.
|
java.lang.String |
getOrderId()
Return the OrderId property.
|
SimpleOrderManager |
getOrderManager()
Return the OrderManager property.
|
RepositoryItem |
getProfile()
Return the Profile property.
|
CommercePropertyManager |
getPropertyManager()
Return the PropertyManager property.
|
int |
getRelationshipCount()
Return the RelationshipCount property.
|
java.lang.String |
getSingleCostCenter()
Return the SingleCostCenter property.
|
protected void |
initializeCommerceIdentifierCostCenters(DynamoHttpServletRequest pRequest,
Order pOrder)
initializeCommerceIdentifierCostCenters creates CommerceIdentifierCostCenter objects
for the Order, the Order's CommerceItems, and the Order's ShippingGroups. |
protected void |
initializeCostCenters(RepositoryItem pProfile)
initializeCostCenters uses the CostCenterManager to create
the user's CostCenters based on the Profile properties given by
getCostCentersPropertyName and getDefaultCostCenterPropertyName . |
protected void |
initializeItemCostCenters(Order pOrder)
The
initializeItemCostCenters method creates a
CommerceIdentifierCostCenter for each CommerceItem
in the Order , and adds them to the CommerceIdentifierCostCenterContainer . |
protected void |
initializeOrderCostCenters(Order pOrder)
The
initializeItemCostCenters method creates a
CommerceIdentifierCostCenter for the Order ,
and adds it to the CommerceIdentifierCostCenterContainer . |
protected void |
initializeRequestParameters(DynamoHttpServletRequest pRequest)
The
initializeRequestParameters method gathers the necessary
input parameters and uses them to adjust initialization requirements. |
protected void |
initializeShippingCostCenters(Order pOrder)
The
initializeItemCostCenters method creates a
CommerceIdentifierCostCenter for each ShippingGroup
in the Order , and adds them to the CommerceIdentifierCostCenterContainer . |
protected void |
initializeTaxCostCenters(Order pOrder)
The
initializeItemCostCenters method creates a
CommerceIdentifierCostCenter for the tax,
and adds it to the CommerceIdentifierCostCenterContainer . |
protected void |
initializeUserCostCenters(DynamoHttpServletRequest pRequest,
RepositoryItem pProfile)
initializeUserCostCenters is used to add the user's
CostCenters to the CostCenterMapContainer. |
boolean |
isClearAll()
Return the ClearAll property.
|
boolean |
isClearCostCenterContainer()
Return the ClearCostCenterContainer property.
|
boolean |
isClearCostCenterMap()
Return the ClearCostCenterMap property.
|
boolean |
isContainsCCOrderRel()
Return the ContainsCCOrderRel property.
|
boolean |
isGetOrderFromId()
Return the GetOrderFromId property.
|
boolean |
isInitCostCenters()
Return the InitCostCenters property.
|
boolean |
isInitItemCostCenters()
Return the InitItemCostCenters property.
|
boolean |
isInitOrderCostCenters()
Return the InitOrderCostCenters property.
|
boolean |
isInitShippingCostCenters()
Return the InitShippingCostCenters property.
|
boolean |
isInitTaxCostCenters()
Return the InitTaxCostCenters property.
|
boolean |
isLoadCostCenters()
Return the LoadCostCenters property.
|
boolean |
isUseAmount()
Return the useAmount property.
|
protected void |
loadItemCostCenters(Order pOrder)
The
loadItemCostCenters method creates a
CommerceIdentifierCostCenter for each CostCenterCommerceItemRelationship
in the Order , and adds them to the CommerceIdentifierCostCenterContainer . |
protected void |
loadOrderCostCenters(Order pOrder)
The
loadShippingCostCenters method creates a
CommerceIdentifierCostCenter for each CostCenterOrderRelationship
in the Order , and adds them to the CommerceIdentifierCostCenterContainer . |
protected void |
loadShippingCostCenters(Order pOrder)
The
loadShippingCostCenters method creates a
CommerceIdentifierCostCenter for each CostCenterShippingGroup
in the Order , and adds them to the CommerceIdentifierCostCenterContainer . |
protected CommerceIdentifierCostCenter |
mergeCommerceIdentifierCostCenters(CommerceIdentifierCostCenter cicc1,
CommerceIdentifierCostCenter cicc2)
mergeCommerceIdentifierCostCenters merges 2 CommerceIdentifierCostCenters
into one by combining their amounts and quantities. |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
The
service method is used to initialize CostCenters and
CommerceIdentifierCostCenter objects. |
void |
setClearAll(boolean pClearAll)
Set the ClearAll property.
|
void |
setClearCostCenterContainer(boolean pClearCostCenterContainer)
Set the ClearCostCenterContainer property.
|
void |
setClearCostCenterMap(boolean pClearCostCenterMap)
Set the ClearCostCenterMap property.
|
void |
setCommerceIdentifierCostCenterContainer(CommerceIdentifierCostCenterContainer pCommerceIdentifierCostCenterContainer)
Set the CommerceIdentifierCostCenterContainer property.
|
void |
setContainsCCOrderRel(boolean pContainsCCOrderRel)
Set the ContainsCCOrderRel property.
|
void |
setCostCenterManager(CostCenterManager pCostCenterManager)
Set the CostCenterManager property.
|
void |
setCostCenterMapContainer(CostCenterMapContainer pCostCenterMapContainer)
Set the CostCenterMapContainer property.
|
void |
setCostCentersPropertyName(java.lang.String pCostCentersPropertyName)
Set the CostCentersPropertyName property.
|
void |
setDefaultCostCenterPropertyName(java.lang.String pDefaultCostCenterPropertyName)
Set the DefaultCostCenterPropertyName property.
|
void |
setGetOrderFromId(boolean pGetOrderFromId)
Set the GetOrderFromId property.
|
void |
setInitCostCenters(boolean pInitCostCenters)
Set the InitCostCenters property.
|
void |
setInitItemCostCenters(boolean pInitItemCostCenters)
Set the InitItemCostCenters property.
|
void |
setInitOrderCostCenters(boolean pInitOrderCostCenters)
Set the InitOrderCostCenters property.
|
void |
setInitShippingCostCenters(boolean pInitShippingCostCenters)
Set the InitShippingCostCenters property.
|
void |
setInitTaxCostCenters(boolean pInitTaxCostCenters)
Set the InitTaxCostCenters property.
|
void |
setLoadCostCenters(boolean pLoadCostCenters)
Set the LoadCostCenters property.
|
void |
setOrder(Order pOrder)
Set the Order property.
|
void |
setOrderId(java.lang.String pOrderId)
Set the OrderId property.
|
void |
setOrderManager(SimpleOrderManager pOrderManager)
Set the OrderManager property.
|
void |
setProfile(RepositoryItem pProfile)
Set the Profile property.
|
void |
setPropertyManager(CommercePropertyManager pPropertyManager)
Set the PropertyManager property.
|
void |
setRelationshipCount(int pRelationshipCount)
Set the RelationshipCount property.
|
void |
setSingleCostCenter(java.lang.String pSingleCostCenter)
Set the SingleCostCenter property.
|
void |
setUseAmount(boolean pUseAmount)
Set the useAmount property.
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
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 java.lang.String mInitializeCostCenterIdentifier
public CostCenterDroplet()
CostCenterDroplet
instance.public void setGetOrderFromId(boolean pGetOrderFromId)
pGetOrderFromId
- a boolean
valuepublic boolean isGetOrderFromId()
boolean
valuepublic void setOrderId(java.lang.String pOrderId)
pOrderId
- a String
valuepublic java.lang.String getOrderId()
String
valuepublic void setOrderManager(SimpleOrderManager pOrderManager)
pOrderManager
- a SimpleOrderManager
valuepublic SimpleOrderManager getOrderManager()
SimpleOrderManager
valuepublic void setOrder(Order pOrder)
pOrder
- an Order
valuepublic Order getOrder()
Order
valuepublic void setProfile(RepositoryItem pProfile)
pProfile
- a Profile
valuepublic RepositoryItem getProfile()
Profile
valuepublic void setClearCostCenterContainer(boolean pClearCostCenterContainer)
pClearCostCenterContainer
- a boolean
valuepublic boolean isClearCostCenterContainer()
boolean
valuepublic void setClearCostCenterMap(boolean pClearCostCenterMap)
pClearCostCenterMap
- a boolean
valuepublic boolean isClearCostCenterMap()
boolean
valuepublic void setClearAll(boolean pClearAll)
pClearAll
- a boolean
valuepublic boolean isClearAll()
boolean
valuepublic void setInitCostCenters(boolean pInitCostCenters)
pInitCostCenters
- a boolean
valuepublic boolean isInitCostCenters()
boolean
valuepublic void setInitItemCostCenters(boolean pInitItemCostCenters)
pInitItemCostCenters
- a boolean
valuepublic boolean isInitItemCostCenters()
boolean
valuepublic void setLoadCostCenters(boolean pLoadCostCenters)
pLoadCostCenters
- a boolean
valuepublic boolean isLoadCostCenters()
boolean
valuepublic void setSingleCostCenter(java.lang.String pSingleCostCenter)
pSingleCostCenter
- a CostCenter
valuepublic java.lang.String getSingleCostCenter()
CostCenter
valuepublic void setUseAmount(boolean pUseAmount)
pUseAmount
- a boolean
valuepublic boolean isUseAmount()
String
valuepublic void setInitShippingCostCenters(boolean pInitShippingCostCenters)
pInitShippingCostCenters
- a boolean
valuepublic boolean isInitShippingCostCenters()
boolean
valuepublic void setInitOrderCostCenters(boolean pInitOrderCostCenters)
pInitOrderCostCenters
- a boolean
valuepublic boolean isInitOrderCostCenters()
boolean
valuepublic void setInitTaxCostCenters(boolean pInitTaxCostCenters)
pInitTaxCostCenters
- a boolean
valuepublic boolean isInitTaxCostCenters()
boolean
valuepublic void setCommerceIdentifierCostCenterContainer(CommerceIdentifierCostCenterContainer pCommerceIdentifierCostCenterContainer)
pCommerceIdentifierCostCenterContainer
- a CommerceIdentifierCostCenterContainer
valuepublic CommerceIdentifierCostCenterContainer getCommerceIdentifierCostCenterContainer()
CommerceIdentifierCostCenterContainer
valuepublic void setCostCenterMapContainer(CostCenterMapContainer pCostCenterMapContainer)
pCostCenterMapContainer
- a CostCenterMapContainer
valuepublic CostCenterMapContainer getCostCenterMapContainer()
CostCenterMapContainer
valuepublic void setCostCenterManager(CostCenterManager pCostCenterManager)
pCostCenterManager
- a CostCenterManager
valuepublic CostCenterManager getCostCenterManager()
CostCenterManager
valuepublic void setPropertyManager(CommercePropertyManager pPropertyManager)
pPropertyManager
- a CommercePropertyManager
valuepublic CommercePropertyManager getPropertyManager()
CommercePropertyManager
valuepublic void setCostCentersPropertyName(java.lang.String pCostCentersPropertyName)
pCostCentersPropertyName
- a String
valuepublic java.lang.String getCostCentersPropertyName()
String
valuepublic void setDefaultCostCenterPropertyName(java.lang.String pDefaultCostCenterPropertyName)
pDefaultCostCenterPropertyName
- a String
valuepublic java.lang.String getDefaultCostCenterPropertyName()
String
valuepublic void setContainsCCOrderRel(boolean pContainsCCOrderRel)
pContainsCCOrderRel
- a boolean
valuepublic boolean isContainsCCOrderRel()
boolean
valuepublic void setRelationshipCount(int pRelationshipCount)
pRelationshipCoiunt
- a int
valuepublic int getRelationshipCount()
int
valueprotected void initializeUserCostCenters(DynamoHttpServletRequest pRequest, RepositoryItem pProfile)
initializeUserCostCenters
is used to add the user's
CostCenters to the CostCenterMapContainer. This invokes the
initializeCostCenters
method.pRequest
- a DynamoHttpServletRequest
valuepProfile
- a Profile
valuepublic java.lang.String getInitializeCostCenterIdentifier()
initializeCostCenters
and assigned
as the cost center name to all the CommerceIdentifierCostCenter
objects when they were first initialized.initializeCostCenters
and assigned
as the cost center name to all the CommerceIdentifierCostCenter
objects when they were first initialized.protected void initializeCostCenters(RepositoryItem pProfile)
initializeCostCenters
uses the CostCenterManager to create
the user's CostCenters based on the Profile properties given by
getCostCentersPropertyName
and getDefaultCostCenterPropertyName
.
All of these CostCenters are added to the CostCenterMapContainer
.
pProfile
- a Profile
valueprotected void initializeCommerceIdentifierCostCenters(DynamoHttpServletRequest pRequest, Order pOrder)
initializeCommerceIdentifierCostCenters
creates CommerceIdentifierCostCenter objects
for the Order, the Order's CommerceItems, and the Order's ShippingGroups.pRequest
- a DynamoHttpServletRequest
valuepOrder
- an Order
valueprotected void initializeItemCostCenters(Order pOrder)
initializeItemCostCenters
method creates a
CommerceIdentifierCostCenter
for each CommerceItem
in the Order
, and adds them to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void loadItemCostCenters(Order pOrder)
loadItemCostCenters
method creates a
CommerceIdentifierCostCenter
for each CostCenterCommerceItemRelationship
in the Order
, and adds them to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void initializeShippingCostCenters(Order pOrder)
initializeItemCostCenters
method creates a
CommerceIdentifierCostCenter
for each ShippingGroup
in the Order
, and adds them to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void loadShippingCostCenters(Order pOrder)
loadShippingCostCenters
method creates a
CommerceIdentifierCostCenter
for each CostCenterShippingGroup
in the Order
, and adds them to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void initializeOrderCostCenters(Order pOrder)
initializeItemCostCenters
method creates a
CommerceIdentifierCostCenter
for the Order
,
and adds it to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void loadOrderCostCenters(Order pOrder)
loadShippingCostCenters
method creates a
CommerceIdentifierCostCenter
for each CostCenterOrderRelationship
in the Order
, and adds them to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void initializeTaxCostCenters(Order pOrder)
initializeItemCostCenters
method creates a
CommerceIdentifierCostCenter
for the tax,
and adds it to the CommerceIdentifierCostCenterContainer
.pOrder
- an Order
valueprotected void initializeRequestParameters(DynamoHttpServletRequest pRequest)
initializeRequestParameters
method gathers the necessary
input parameters and uses them to adjust initialization requirements.pRequest
- a DynamoHttpServletRequest
valuepublic CostCenter getDefaultCostCenter()
getDefaultCostCenterName
method returns the default CostCenter
based on the CostCenterMapContainer's default CostCenter name. Any .jhtml
form can manipulate this item directly.String
valuepublic void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
method is used to initialize CostCenters and
CommerceIdentifierCostCenter objects. Initialization is based on input
parameters describing which CommerceIdentifiers in the Order will be
associated with CostCenters.
The resulting Collections of CostCenters and CommerceIdentifierCostCenters
are exposed via output parameters.service
in class DynamoServlet
pRequest
- a DynamoHttpServletRequest
valuepResponse
- a DynamoHttpServletResponse
valuejavax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected void consolidateCommerceIdentifierCostCenters(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
consolidateCommerceIdentifierCostCenters
consolidates CommerceIdentifierCostCenters
by ensuring there is no redundant data. CommerceIdentifierCostCenters that have zero
amounts and quantities are removed, and those that refer to the same CommerceIdentifier are
merged into one CommerceIdentifierCostCenter.pRequest
- a DynamoHttpServletRequest
valuepResponse
- a DynamoHttpServletResponse
valuejavax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected CommerceIdentifierCostCenter mergeCommerceIdentifierCostCenters(CommerceIdentifierCostCenter cicc1, CommerceIdentifierCostCenter cicc2)
mergeCommerceIdentifierCostCenters
merges 2 CommerceIdentifierCostCenters
into one by combining their amounts and quantities.cicc1
- a CommerceIdentifierCostCenter
valuecicc2
- a CommerceIdentifierCostCenter
valueCommerceIdentifierCostCenter
value