atg.projects.store.recommendations.processor
Class OrderSubmitProcessor

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.adc.pipeline.ADCPipelineProcessor
              atg.adc.pipeline.ADCEventPipelineProcessor
                  atg.projects.store.recommendations.processor.TrackingCodeProcessor
                      atg.projects.store.recommendations.processor.OrderSubmitProcessor

All Implemented Interfaces:

atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.service.pipeline.PipelineProcessor, java.util.EventListener

public class OrderSubmitProcessor
extends TrackingCodeProcessor

This processor is responsible for generating clickstream tracking code markup for order confirmation page. It extends TrackingCodeProcessor and overrides its buildTrackingCodeContent() method in order to add 'checkout' entry to the tracking code DIV element. The 'checkout' entry consists of cart content entry. The cart content entry is built using the buildCartEntry() method inherited from the parent class.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/Recommendations/src/atg/projects/store/recommendations/processor/OrderSubmitProcessor.java#2 $Change: 630322 $

Author:

Yekaterina Kostenevich

Field Summary

static java.lang.String	CHECKOUT_ENTRY Entries format constants
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.projects.store.recommendations.processor.TrackingCodeProcessor

CART_ENTRY, CUSTOMER_ID_ENTRY, DEFAULT_TIMEOUT, DISABLED_FAILOVER, EXCLUDE_DEFAULT_STORE_ENTRY, FAILOVER_CONTENT, FAILOVER_ENTRY, FAILOVER_SKIP_RECOMMENDATIONS, FAILOVER_TIMEOUT_ENTRY, INCLUDE_PRICE_ENTRY, LOCALE_ENTRY, PERFORM_MONITOR_NAME, PERFORM_OPERATION_NAME, PRODUCT_ENTRY, RETAILER_ID_ENTRY, STORE_ID_ENTRY, TRACKING_DIV, VIEW_ENTRY

Fields inherited from class atg.adc.pipeline.ADCEventPipelineProcessor

sResourceBundle

Fields inherited from class atg.adc.pipeline.ADCPipelineProcessor

MADE_CHANGE, NO_CHANGE

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

OrderSubmitProcessor()

Method Summary

protected java.lang.String	buildCheckoutEntry(atg.adc.pipeline.ADCPipelineArgs pArgs) Builds 'checkout' entry for the recommendations clickstream tracking code.
protected java.lang.String	buildTrackingCodeContent(atg.adc.pipeline.ADCPipelineArgs pArgs) Overrides base TrackingCodeProcessor's method in order to append 'checkout' entry to the tracking code DIV element's content.
protected boolean	validateRequiredData(atg.adc.pipeline.ADCPipelineArgs pArgs) Overrides base TrackingCodeProcessor's method in order to check whether order is specified in ADCRequestData object stored in the ADC pipeline arguments.

Methods inherited from class atg.projects.store.recommendations.processor.TrackingCodeProcessor

appendEntry, buildCartEntry, buildCustomerIdEntry, buildExcludeDefaultStoreEntry, buildFailoverEntry, buildIncludePriceEntry, buildLocaleEntry, buildRetailerIdEntry, buildStoreIdEntry, buildTrackingCode, buildTrackingCodeViewContent, buildTrackingCodeViewEntry, getCurrentOrder, getFailoverTimeout, getPriceListManager, getRetailerId, getShoppingCartPath, isEnableFailover, isExcludeDefaultStore, isIncludeCartContent, isIncludeLocale, isIncludePrice, isSkipRecommendations, isUseContentFailover, processADCData, processEvent, setEnableFailover, setExcludeDefaultStore, setFailoverTimeout, setIncludeLocale, setIncludePrice, setPriceListManager, setRetailerId, setShoppingCartPath, setSkipRecommendations, setUseContentFailover, updateADCData

Methods inherited from class atg.adc.pipeline.ADCEventPipelineProcessor

getJMSTypes, getObjectFromMessage, processEvents, setJMSTypes

Methods inherited from class atg.adc.pipeline.ADCPipelineProcessor

getRetCodes, isEnabled, runProcess, setEnabled

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

CHECKOUT_ENTRY

public static final java.lang.String CHECKOUT_ENTRY

Entries format constants

See Also:

Constant Field Values

Constructor Detail

OrderSubmitProcessor

public OrderSubmitProcessor()

Method Detail

validateRequiredData

protected boolean validateRequiredData(atg.adc.pipeline.ADCPipelineArgs pArgs)

Overrides base TrackingCodeProcessor's method in order to check whether order is specified in ADCRequestData object stored in the ADC pipeline arguments. If not the further processing will be stopped.

Overrides:

validateRequiredData in class TrackingCodeProcessor

Parameters:

pArgs - The pipeline arguments

Returns:

true if order is found in ADC request data

buildTrackingCodeContent

protected java.lang.String buildTrackingCodeContent(atg.adc.pipeline.ADCPipelineArgs pArgs)

Overrides base TrackingCodeProcessor's method in order to append 'checkout' entry to the tracking code DIV element's content.

Overrides:

buildTrackingCodeContent in class TrackingCodeProcessor

Parameters:

pArgs - ADC pipeline arguments

Returns:

view entry for the recommendations clickstream tracking code

buildCheckoutEntry

protected java.lang.String buildCheckoutEntry(atg.adc.pipeline.ADCPipelineArgs pArgs)

Builds 'checkout' entry for the recommendations clickstream tracking code. It consists from the 'cart' entry containing order product IDs and order's subtotal price. The cart entry is build using the buildCartEntry() method inherited from the TrackingCodeProcessor parent class. The order object obtained from the ADCRequestData.

Parameters:

pArgs - ADC pipeline arguments

Returns:

checkout tracking code entry