com.ibm.commerce.ordermanagement.commands

Class AdvancedOrderEditBeginCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.order.commands.OrderBaseCmdImpl

com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBaseCmdImpl

com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBeginCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AdvancedOrderEditBeginCmd, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

SOIAdvancedOrderEditBeginCmdImpl

public class AdvancedOrderEditBeginCmdImpl
extends com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBaseCmdImpl
implements AdvancedOrderEditBeginCmd

This is the default implementation of the AdvancedOrderEditBeginCmd controller command.

Input parameters:

Name	Description
orderId	(Required) The identifier of the order to edit or change.
editorId	An authorized and logged in member who invoked the AdvancedOrderEditBeginCmd command.

Output parameters:

Behaviour:

This AdvancedOrderEditBeginCmd implementation class and AdvancedOrderEditEndCmd command stage an advanced order for editing. Between the execution of the AdvancedOrderEditBeginCmd and AdvancedOrderEditEndCmd commands, many types of order editing actions can occur (for example, OrderItemUpdateCmd, PIEdit, OrderCopy, and so on.).

To invoke this command:

• A valid order ID has to be passed in from command context.
• A qualified editorId be passed. The editorId must be a registered member; otherwise, an exception is thrown.
• The order status has to be one of (P, E, New, M, B, C, N, W, I, L, A,Quote NEW).

This command will create order history or extract old one if order history is enabled. After the command is invoked, the order is in an editable state. An exception is thrown if an invalid order is passed.

After the command is successful executed, the status of order will change to E unless the status was P, NEW, and E. And the order will not be processed by the system until the order gets submitted again.

If unsuccessful, the command throws the ECException.

Task commands called:

• ProcessPaymentEventCmd
• RecordOrderHistoryTaskCmd
• CheckOrderEditableTaskCmd

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright statement.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBeginCmd

defaultCommandClassName, EC_ORDER_RN, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AdvancedOrderEditBeginCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Short	getOrderVersion() This method returns the order version number.
void	performExecute() Executes the business logic of this command implementation.
void	setEditor(OrderAccessBean anOrder) Sets the editor ID with the value of the login ID.
void	setRequestProperties(TypedProperty reqProperties) This method sets the requestProperties for the command.
void	setResponseProperties() Set the response properties.
void	setTakeOverLock(java.lang.String takeOverLock) Set take over lock parameter

Methods inherited from class com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBaseCmdImpl

getEditorId, getOrder, getOrderId, getResources, isGeneric, isRetriable, reset, setEditorId, setOrder, setOrderId, toString, validateParameters

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBeginCmd

setOrder, setOrderId

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement.

See Also:

Constant Field Values

Constructor Detail

AdvancedOrderEditBeginCmdImpl

public AdvancedOrderEditBeginCmdImpl()

Method Detail

performExecute

public void performExecute()
                    throws ECException

Executes the business logic of this command implementation.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Specified by:

performExecute in class com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBaseCmdImpl

Throws:

ECException

setEditor

public void setEditor(OrderAccessBean anOrder)
               throws ECException

Sets the editor ID with the value of the login ID.

Parameters:

anOrder - as OrderAcessBean

Throws:

ECException

getOrderVersion

public java.lang.Short getOrderVersion()

Description copied from interface: AdvancedOrderEditBeginCmd

This method returns the order version number.

Specified by:

getOrderVersion in interface AdvancedOrderEditBeginCmd

Returns:

the order version number.

setResponseProperties

public void setResponseProperties()

Set the response properties.

See Also:

ControllerCommandImpl.setResponseProperties(com.ibm.commerce.datatype.TypedProperty)

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

Description copied from class: ControllerCommandImpl

This method sets the requestProperties for the command. The WebController calls the setRequestProperties method before invoking the execute method for this command. It is the responsibility of the command writer to extract the required input parameters from the requestProperties object.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class com.ibm.commerce.ordermanagement.commands.AdvancedOrderEditBaseCmdImpl

Parameters:

reqProperties - This is an object that represents the request properties.

Throws:

ECException

See Also:

ControllerCommand.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)

setTakeOverLock

public void setTakeOverLock(java.lang.String takeOverLock)

Set take over lock parameter

Specified by:

setTakeOverLock in interface AdvancedOrderEditBeginCmd

Parameters:

takeOverLock -