com.ibm.commerce.messaging.commands

Interface OrderItemStatusCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

OrderItemStatusCmdImpl

public interface OrderItemStatusCmd
extends TaskCommand

The interface for the OrderItemStatus command. This command processes the status message that the backend system creates when any change occurs to items belonging to an order. This command is usually called by the order status command.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.
static java.lang.String	defaultCommandClassName The default class containing the implementation of the OrderItemStatus command.
static java.lang.String	NAME The name of the class.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
boolean	doPostProcess(TypedProperty aRequestProperty) This method performs a verification check after the command executes.
boolean	doPreProcess(TypedProperty aRequestProperty) This method performs a verification check before the command executes.
boolean	doProcess(TypedProperty aRequestProperty) This method performs the proper business logic for the OrderItemStatus command.
void	setOrderItemStatusProperties(TypedProperty aRequestProperties) Binds the parameters received by the request properties to variables that are used for determining the order item to update.

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

execute

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, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute, reset

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

unionDependencies

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

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the class.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default class containing the implementation of the OrderItemStatus command.

See Also:

Constant Field Values

Method Detail

doPostProcess

boolean doPostProcess(TypedProperty aRequestProperty)
               throws ECException

This method performs a verification check after the command executes.

Parameters:

aRequestProperty - Parameters used to aid the checking

Returns:

True if the command executes successfully, otherwise false.

Throws:

ECException - Raised when the checking raises any exceptions.

doPreProcess

boolean doPreProcess(TypedProperty aRequestProperty)
              throws ECException

This method performs a verification check before the command executes.

Parameters:

aRequestProperty - Parameters used to aid the checking

Returns:

True if the command can be executed, otherwise false.

Throws:

ECException - Raised when the checking raises any exceptions

doProcess

boolean doProcess(TypedProperty aRequestProperty)
           throws ECException

This method performs the proper business logic for the OrderItemStatus command.

Parameters:

aRequestProperty - Input parameters

Returns:

True if the command executes successfully, otherwise false.

Throws:

ECException - Raised if the update fails

setOrderItemStatusProperties

void setOrderItemStatusProperties(TypedProperty aRequestProperties)
                           throws ECException

Binds the parameters received by the request properties to variables that are used for determining the order item to update. Also, a validation check is performed on some of the given parameters and if this check fails, an ECException is thrown.

Parameters:

aRequestProperty - name-value pair containing the input parameters key orderId is mapped to variable iOrderId key merchantOrderNumber is mapped to iMerchantOrderNumber key orderItemId is mapped to variable iOrderItemId key merchantItemNumber is mapped to variable iMerchantitemNumber

Throws:

ECException - Raised when any of the required parameters are missing