atg.projects.b2cstore
Class CancelOrder

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.nucleus.servlet.ServletService
                  extended by atg.nucleus.servlet.HttpServletService
                      extended by atg.servlet.DynamoServlet
                          extended by atg.commerce.order.OrderLookup
                              extended by atg.projects.b2cstore.CancelOrder
All Implemented Interfaces:
atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

Deprecated. Use the atg.commerce.order.purchase.CancelOrderFormHandler instead

public class CancelOrder
extends OrderLookup

This servlet cancels the order for the orderId paramteter passed in. It takes as parameters:

orderId
the id of the order to cancel
It renders the following oparams:
success
The oparam success is rendered once if the cancel was successful
error
error will be rendered if an error occurred
It sets the following output params:
errorMsg
if an error occurred this will be the detailed error message for the user.
This droplet has a security feature that allows only the current user to cancel his own orders. This feature is enabled by default. To disable it, set the property enableSecurity=false


Field Summary
static java.lang.String CLASS_VERSION
          Deprecated.  
static java.lang.String SUCCESS
          Deprecated.  
 
Fields inherited from class atg.commerce.order.OrderLookup
ALL, CLOSED, CLOSEDSTATES, COSTCENTERID, COUNT, CURRENT, DEFAULT_NUM_ORDERS, EMPTY, ENDRANGE, ERROR, ERRORMESSAGE, mProfilePath, MSG_GENERAL_ERROR, MSG_NO_PARAM_SPECIFIED, MSG_NO_PERMISSION_FOR_ORDER, MSG_NO_PERMISSION_FOR_USERS_ORDERS, MSG_NO_SUCH_ORDER, NEXTINDEX, NUMORDERS, OPEN, OPENSTATES, ORDERID, OUTPUT, PREVIOUSINDEX, QUERYTOTAL, QUERYTOTALONLY, RESULT, SITEIDS, SITESCOPE, SORTASCENDING, SORTBY, STARTINDEX, STARTRANGE, STATE, TOTAL_COUNT, TOTALCOUNT, USERID
 
Fields inherited from class atg.servlet.DynamoServlet
mAllowCleanupRequest, mParameters
 
Fields inherited from class atg.nucleus.servlet.ServletService
SERVLET_INFO_KEY
 
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
CancelOrder()
          Deprecated.  
 
Method Summary
 OrderCanceller getOrderCanceller()
          Deprecated.  
 void service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes)
          Deprecated. service the request
 void setOrderCanceller(OrderCanceller pOrderCanceller)
          Deprecated.  
 
Methods inherited from class atg.commerce.order.OrderLookup
getClosedStates, getCostCenterManager, getCurrentProfileId, getDefaultLocale, getDefaultNumOrders, getOpenStates, getOrderLookupService, getOrderManager, getProfilePath, getSiteGroupManager, getSiteScope, getUserLocale, isEnableSecurity, isQueryTotal, isSearchByCostCenterId, isSearchByOrderId, isSearchByUserId, isUseRequestLocale, SearchByCostCenterId, searchByOrderId, SearchByOrderId, searchByUserId, SearchByUserId, setClosedStates, setCostCenterManager, setDefaultLocale, setDefaultNumOrders, setEnableSecurity, setOpenStates, setOrderLookupService, setOrderManager, setProfilePath, setQueryTotal, setSearchByCostCenterId, setSearchByOrderId, setSearchByUserId, setSiteGroupManager, setSiteScope, setUseRequestLocale
 
Methods inherited from class atg.servlet.DynamoServlet
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
 
Methods inherited from class atg.nucleus.servlet.ServletService
destroy, getServletConfig, getServletInfo, setServletInfo
 
Methods inherited from class atg.nucleus.TimedOperationService
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
 
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
Deprecated. 

SUCCESS

public static final java.lang.String SUCCESS
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

CancelOrder

public CancelOrder()
Deprecated. 
Method Detail

setOrderCanceller

public void setOrderCanceller(OrderCanceller pOrderCanceller)
Deprecated. 

getOrderCanceller

public OrderCanceller getOrderCanceller()
Deprecated. 

service

public void service(DynamoHttpServletRequest pReq,
                    DynamoHttpServletResponse pRes)
             throws javax.servlet.ServletException,
                    java.io.IOException
Deprecated. 
service the request

Overrides:
service in class OrderLookup
Parameters:
pReq - the request to be processed
pRes - the response object for this request
Throws:
javax.servlet.ServletException - an application specific error occurred processing this request
java.io.IOException - an error occurred reading data from the request or writing data to the response.