atg.commerce.csr.clicktoconnect
Class OrderViewLandingPageHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.svc.clicktoconnect.LandingPageHandler
              atg.svc.clicktoconnect.URIMatchLandingPageHandler
                  atg.commerce.csr.clicktoconnect.OrderViewLandingPageHandler

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, 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, java.util.EventListener

public class OrderViewLandingPageHandler
extends atg.svc.clicktoconnect.URIMatchLandingPageHandler

This handler generates a landing page for the order view or scheduled order view depending on the state of the order.

The order id is expected to be a parameter on the referrer url using the parameter name configured by the orderIdParameterName property.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected CSREnvironmentTools	mCSREnvironmentTools
protected atg.svc.clicktoconnect.LandingPage	mOrderViewLandingPage
protected atg.svc.clicktoconnect.LandingPage	mScheduledOrderViewLandingPage

Fields inherited from class atg.svc.clicktoconnect.URIMatchLandingPageHandler

mURIMatches, mVirtualContextRootService

Fields inherited from class atg.svc.clicktoconnect.LandingPageHandler

mEnvironmentTools, mLandingPage

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

OrderViewLandingPageHandler()

Method Summary

protected atg.svc.clicktoconnect.LandingPage	createLandingPage(atg.svc.clicktoconnect.C2CRequestData pC2CRequestData) Extends the base behavior to load the order into the view order holder and return the correct landing page based on the order state.
CSREnvironmentTools	getCSREnvironmentTools()
java.lang.String	getOrderIdParameterName() Returns the parameter name of the order id in the referrer url
atg.svc.clicktoconnect.LandingPage	getOrderViewLandingPage() Returns the landing page for viewing an existing order
atg.svc.clicktoconnect.LandingPage	getScheduledOrderViewLandingPage() Returns the landing page for the view an existing scheduled order.
void	setCSREnvironmentTools(CSREnvironmentTools pCSREnvironmentTools) Sets the property CSREnvironmentTools.
void	setOrderIdParameterName(java.lang.String pOrderIdParameterName)
void	setOrderViewLandingPage(atg.svc.clicktoconnect.LandingPage pOrderViewLandingPage)
void	setScheduledOrderViewLandingPage(atg.svc.clicktoconnect.LandingPage pScheduledOrderViewLandingPage)

Methods inherited from class atg.svc.clicktoconnect.URIMatchLandingPageHandler

generateLandingPage, getURIMatches, getVirtualContextRootService, isFileURIMatch, isURIMatch, setURIMatches, setVirtualContextRootService

Methods inherited from class atg.svc.clicktoconnect.LandingPageHandler

getEnvironmentTools, getLandingPage, getReferrerParameter, setEnvironmentTools, setLandingPage

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 java.lang.String CLASS_VERSION

Class version string

mCSREnvironmentTools

protected CSREnvironmentTools mCSREnvironmentTools

mOrderViewLandingPage

protected atg.svc.clicktoconnect.LandingPage mOrderViewLandingPage

mScheduledOrderViewLandingPage

protected atg.svc.clicktoconnect.LandingPage mScheduledOrderViewLandingPage

Constructor Detail

OrderViewLandingPageHandler

public OrderViewLandingPageHandler()

Method Detail

getOrderIdParameterName

public java.lang.String getOrderIdParameterName()

Returns the parameter name of the order id in the referrer url

Returns:

String

setOrderIdParameterName

public void setOrderIdParameterName(java.lang.String pOrderIdParameterName)

setCSREnvironmentTools

public void setCSREnvironmentTools(CSREnvironmentTools pCSREnvironmentTools)

Sets the property CSREnvironmentTools.

getCSREnvironmentTools

public CSREnvironmentTools getCSREnvironmentTools()

Returns:

The CSREnvironmentTools component used to manipulate the profile

getOrderViewLandingPage

public atg.svc.clicktoconnect.LandingPage getOrderViewLandingPage()

Returns the landing page for viewing an existing order

Returns:

LandingPage

setOrderViewLandingPage

public void setOrderViewLandingPage(atg.svc.clicktoconnect.LandingPage pOrderViewLandingPage)

getScheduledOrderViewLandingPage

public atg.svc.clicktoconnect.LandingPage getScheduledOrderViewLandingPage()

Returns the landing page for the view an existing scheduled order.

Returns:

LandingPage

setScheduledOrderViewLandingPage

public void setScheduledOrderViewLandingPage(atg.svc.clicktoconnect.LandingPage pScheduledOrderViewLandingPage)

createLandingPage

protected atg.svc.clicktoconnect.LandingPage createLandingPage(atg.svc.clicktoconnect.C2CRequestData pC2CRequestData)

Extends the base behavior to load the order into the view order holder and return the correct landing page based on the order state.

Overrides:

createLandingPage in class atg.svc.clicktoconnect.URIMatchLandingPageHandler