com.ibm.commerce.orderitems.commands

Interface OrderItemDeleteCmd

All Superinterfaces:

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

All Known Implementing Classes:

OrderItemDeleteCmdImpl, QuoteItemDeleteCmdImpl

public interface OrderItemDeleteCmd
extends ControllerCommand

This Order controller command is used to delete some order items from one or more pending orders for some orderitemIds or product. The default implementation of this command is OrderItemDeleteCmdImpl.

Behavior

• For each of the order items to be deleted, the command does the following if orderItemId is specified:
  • Obtains the order that the order item is associated with.
  • If the order is in pending state, unlocks it and updates the timestamp.
  • Deletes the order items.
• The command does the following if catEntryId is specified:
  • Compiles the list of orders for processing.
    The ResolveOrdersCmd task command is invoked to obtain the current pending orders, if needed.
  • Does the following for each order in the list:
    • If the order is in pending state and the order items for the order contain the specified product, unlocks the order and updates the timestamp.
    • Deletes all the order items that contain the specified product.

View Task: RedirectView

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The name of the Command Interface class.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setCatEntryId(java.lang.String[] ids) This method sets a list of catalog entry ids to be deleted from the pending orders specified by orderId.
void	setOrderId(java.lang.String[] ids) This method sets zero or more orders, using order ids or one of the special abbreviations ".", "*", ".t", "*t".
void	setOrderItemId(java.lang.String[] numbers) This method sets an array of id of order items to be deleted.
void	setOutOrderName(java.lang.String[] names) This method sets the names of name-value pairs to add to the redirection URL.

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, performExecute, 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, performExecute, 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

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the Command Interface class.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

Method Detail

setCatEntryId

void setCatEntryId(java.lang.String[] ids)

This method sets a list of catalog entry ids to be deleted from the pending orders specified by orderId. This parameter is mandatory if orderItemId is not set. This parameter is ignored if orderItemId is set.

Parameters:

ids - an array of catalog entry ids.

setOrderId

void setOrderId(java.lang.String[] ids)

This method sets zero or more orders, using order ids or one of the special abbreviations ".", "*", ".t", "*t". See OrderItem Commands for a description of these abbreviations. If this parameter is omitted, it defaults to "."

Parameters:

ids - an array of order Ids.

setOrderItemId

void setOrderItemId(java.lang.String[] numbers)

This method sets an array of id of order items to be deleted.

Parameters:

numbers - an array of order item Ids.

setOutOrderName

void setOutOrderName(java.lang.String[] names)

This method sets the names of name-value pairs to add to the redirection URL. The values of the added name-value pairs are the reference numbers of the input orders.

Parameters:

names - an array of out order names.