atg.projects.b2bstore.order

Class CancelOrder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.projects.b2bstore.order.CancelOrder

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, 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, java.util.EventListener

Deprecated.

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

public class CancelOrder
extends GenericFormHandler

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

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Deprecated.
static java.lang.String	SUCCESS Deprecated.

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

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

Constructors

Constructor and Description
CancelOrder() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCancelOrderErrorURL() Deprecated. returns the property cancelOrderErrorURL
java.lang.String	getCancelOrderSuccessURL() Deprecated. returns the property cancelOrderSuccessURL
protected java.lang.String	getCurrentProfileId(DynamoHttpServletRequest pReq) Deprecated.
OrderCanceller	getOrderCanceller() Deprecated.
java.lang.String	getOrderId() Deprecated. returns the property orderId
OrderManager	getOrderManager() Deprecated. returns the property orderManager
java.lang.String	getProfilePath() Deprecated. returns the property profilePath
boolean	handleCancelOrder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Deprecated. handleSubmit
boolean	isEnableSecurity() Deprecated. returns the property enableSecurity
void	setCancelOrderErrorURL(java.lang.String pCancelOrderErrorURL) Deprecated. set the propertycancelOrderErrorURL
void	setCancelOrderSuccessURL(java.lang.String pCancelOrderSuccessURL) Deprecated. set the propertycancelOrderSuccessURL
void	setEnableSecurity(boolean pEnableSecurity) Deprecated. set the propertyenableSecurity
void	setOrderCanceller(OrderCanceller pOrderCanceller) Deprecated.
void	setOrderId(java.lang.String pOrderId) Deprecated. set the propertyorderId
void	setOrderManager(OrderManager pOrderManager) Deprecated. set the propertyorderManager
void	setProfilePath(java.lang.String pProfilePath) Deprecated. set the propertyprofilePath

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

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, toString

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, 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.

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Deprecated.

set the propertyorderManager

Parameters:

pOrderManager - a String value

getOrderManager

public OrderManager getOrderManager()

Deprecated.

returns the property orderManager

Returns:

a OrderManager value

setOrderId

public void setOrderId(java.lang.String pOrderId)

Deprecated.

set the propertyorderId

Parameters:

pOrderId - a String value

getOrderId

public java.lang.String getOrderId()

Deprecated.

returns the property orderId

Returns:

a String value

setEnableSecurity

public void setEnableSecurity(boolean pEnableSecurity)

Deprecated.

set the propertyenableSecurity

Parameters:

pEnableSecurity - a String value

isEnableSecurity

public boolean isEnableSecurity()

Deprecated.

returns the property enableSecurity

Returns:

a boolean value

setProfilePath

public void setProfilePath(java.lang.String pProfilePath)

Deprecated.

set the propertyprofilePath

Parameters:

pProfilePath - a String value

getProfilePath

public java.lang.String getProfilePath()

Deprecated.

returns the property profilePath

Returns:

a String value

setCancelOrderErrorURL

public void setCancelOrderErrorURL(java.lang.String pCancelOrderErrorURL)

Deprecated.

set the propertycancelOrderErrorURL

Parameters:

pCancelOrderErrorURL - a String value

getCancelOrderErrorURL

public java.lang.String getCancelOrderErrorURL()

Deprecated.

returns the property cancelOrderErrorURL

Returns:

a String value

setCancelOrderSuccessURL

public void setCancelOrderSuccessURL(java.lang.String pCancelOrderSuccessURL)

Deprecated.

set the propertycancelOrderSuccessURL

Parameters:

pCancelOrderSuccessURL - a String value

getCancelOrderSuccessURL

public java.lang.String getCancelOrderSuccessURL()

Deprecated.

returns the property cancelOrderSuccessURL

Returns:

a String value

getCurrentProfileId

protected java.lang.String getCurrentProfileId(DynamoHttpServletRequest pReq)

Deprecated.

handleCancelOrder

public boolean handleCancelOrder(DynamoHttpServletRequest pRequest,
                                 DynamoHttpServletResponse pResponse)
                          throws java.io.IOException,
                                 javax.servlet.ServletException

Deprecated.

handleSubmit

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

a boolean value

Throws:

java.io.IOException - if an error occurs

javax.servlet.ServletException - if an error occurs