atg.commerce.markers.bp
Class OrderBasedProcessConfiguration

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.markers.ValidateMarkerByPossibleValue
              atg.markers.ConfigurableMarkerValidator
                  atg.markers.bp.BusinessProcessConfiguration
                      atg.commerce.markers.bp.OrderBasedProcessConfiguration

All Implemented Interfaces:

BusinessProcessConstants, MarkerConstants, MarkerValidator, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class OrderBasedProcessConfiguration
extends BusinessProcessConfiguration

Business Process configuration class for a process based on orders.

The following are the properties of a OrderBasedProcessConfiguration.

orderMarkerManager

defines the OrderMarkerManager to use for this business process. If this is not specified in the property configuration it will default to the componenet /atg/commerce/markers/OrderMarkerManager.

shoppingCartPath

The nucleus path to the shopping cart

The findOrder method is called by the business process manager to get the order to be marked. This method defaults to the shopping cart's current order.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected OrderMarkerManager	mOrderMarkerManager
protected java.lang.String	mShoppingCartPath

Fields inherited from class atg.markers.bp.BusinessProcessConfiguration

mBusinessProcessName, mDuplicationMode, mEnabled, mGenerateEvents, mMarkedItemType, mMarkerItemType, mMarkerPropertyName, mMarkerValidatorContainer, mStageNames

Fields inherited from class atg.markers.ValidateMarkerByPossibleValue

mAcceptAllValues, mNullValueValid

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.markers.bp.BusinessProcessConstants

BUSINESS_PROCESS_RESOURCE_NAME, sBusinessProcessResourceBundle

Fields inherited from interface atg.markers.MarkerConstants

ALLOW_DUPLICATES, ANY_VALUE, DEFAULT_MARKER_ID_PROPERTY_NAME, DEFAULT_MARKER_ITEM_TYPE, DEFAULT_MARKER_PROPERTY_NAME, DEFAULT_MARKER_SORT_PROPERTY_NAME, MARKER_CREATIONDATE_PROPERTY_NAME, MARKER_DATA_PROPERTY_NAME, MARKER_DUPLICATIONMODE_PROPERTY_NAME, MARKER_KEY_PROPERTY_NAME, MARKER_OWNER_PROPERTY_NAME, MARKER_RESOURCE_NAME, MARKER_VALUE_PROPERTY_NAME, NO_DUPLICATES, PARAM_DATA, PARAM_DUPMODE, PARAM_EXTENDED_PROPERTIES, PARAM_ITEM, PARAM_ITEM_ID, PARAM_KEY, PARAM_MARKED_ITEM_TYPE, PARAM_MARKER_ITEM_TYPE, PARAM_MARKER_MANAGER, PARAM_MARKER_PROPERTY_NAME, PARAM_VALUE, REPLACE_DUPLICATES, sResourceBundle

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

OrderBasedProcessConfiguration()

Method Summary

Order	findOrder() Finds the order to be used for the business process.
java.lang.String	getMarkedItemType() This extension will return the default marked item type of the configured OrderMarkerManager if the property is not already configured.
MarkerValidatorContainer	getMarkerValidatorContainer() Gets the MarkerValidator that contains this marker validator.
OrderMarkerManager	getOrderMarkerManager() Returns the OrderMarkerManager to use for the business process.
java.lang.String	getShoppingCartPath() Returns property ShoppingCartPath
void	setOrderMarkerManager(OrderMarkerManager pOrderMarkerManager) The OrderMarkerManager to use for this business process
void	setShoppingCartPath(java.lang.String pShoppingCartPath) Sets property ShoppingCartPath
void	validateConfiguration() Validates the property settings for the configuration component

Methods inherited from class atg.markers.bp.BusinessProcessConfiguration

doStartService, getBusinessProcessName, getDuplicationMode, getMarkerItemType, getMarkerPropertyName, getPossibleValues, getStageNames, isEnabled, isGenerateEvents, isNullValueValid, setBusinessProcessName, setDuplicationMode, setEnabled, setGenerateEvents, setMarkedItemType, setMarkerItemType, setMarkerPropertyName, setMarkerValidatorContainer, setStageNames

Methods inherited from class atg.markers.ConfigurableMarkerValidator

getValidValuesForKey, setPossibleValues

Methods inherited from class atg.markers.ValidateMarkerByPossibleValue

isAcceptAllValues, isValidMarker, isValidValueForKey, setAcceptAllValues, setNullValueValid

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

mOrderMarkerManager

protected OrderMarkerManager mOrderMarkerManager

mShoppingCartPath

protected java.lang.String mShoppingCartPath

Constructor Detail

OrderBasedProcessConfiguration

public OrderBasedProcessConfiguration()

Method Detail

getMarkedItemType

public java.lang.String getMarkedItemType()

This extension will return the default marked item type of the configured OrderMarkerManager if the property is not already configured.

Overrides:

getMarkedItemType in class BusinessProcessConfiguration

Returns:

the marked item type.

setOrderMarkerManager

public void setOrderMarkerManager(OrderMarkerManager pOrderMarkerManager)

The OrderMarkerManager to use for this business process

getOrderMarkerManager

public OrderMarkerManager getOrderMarkerManager()

Returns the OrderMarkerManager to use for the business process.

If this property is not set in the property file configuration this method will automatically return the nucleus component /atg/commerce/markers/OrderMarkerManager.

setShoppingCartPath

public void setShoppingCartPath(java.lang.String pShoppingCartPath)

Sets property ShoppingCartPath

getShoppingCartPath

public java.lang.String getShoppingCartPath()

Returns property ShoppingCartPath

findOrder

public Order findOrder()

Finds the order to be used for the business process. This method is called by the CommerceBusinessProcessManager when an order is not provided through its API.

By default this method returns the shopping cart's current order

Returns:

the order

getMarkerValidatorContainer

public MarkerValidatorContainer getMarkerValidatorContainer()

Gets the MarkerValidator that contains this marker validator.

Overrides:

getMarkerValidatorContainer in class BusinessProcessConfiguration

Returns:

the MarkerValidatorContainer that contains this marker validator.

validateConfiguration

public void validateConfiguration()
                           throws BusinessProcessException

Validates the property settings for the configuration component

Overrides:

validateConfiguration in class BusinessProcessConfiguration

Throws:

BusinessProcessException - for properties that aren't properly configured.