OrderItemDeleteCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.order.commands.OrderBaseCmdImpl
      - com.ibm.commerce.orderitems.commands.OrderItemDeleteCmdImpl

All Implemented Interfaces:: AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderItemDeleteCmd, Protectable, 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:: QuoteItemDeleteCmdImpl

public class OrderItemDeleteCmdImpl
extends OrderBaseCmdImpl
implements OrderItemDeleteCmd

This is the default implementation of the OrderItemDeleteCmd controller command.

Input parameters:

Name	Description
`orderItemId`	The `orderitem` Ids, the order items to be deleted. Mandatory if `catEntryId` is not specified.
`catEntryId`	The catalog entry Ids, to which the order items to be deleted. Mandatory if `orderItemId` is not specified.
`orderId`	The order Ids. Mandatory if `orderItemId` is not specified.
`outOrderName`	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. Optional.
`calculateOrder`	If order will be recalculated after some order items are removed. The values can be `1` for recalculate or `0` for not recalculate. Default value is `0`

Output parameters:

Name	Description
The value for `outOrderName[i]`	The array of order Ids.
`orderId`	If `outOrderName` is empty, used as outOrderName.

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.
The command will call OrderCalculateCmd to calculate the whole if the passed parameter calculateOrder=1 for calculation usage CalculationConstants.USAGE_DISCOUNT

View Task: RedirectView

This command uses the following AccessBeans:

See Also:: OrderCalculateCmd, ResolveOrdersCmd

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`protected java.lang.String[]`	`iCatEntryId` Catalog entry Ids.
`protected java.lang.String[]`	`iOrderId` Order ids abbreviations.
`protected TypedProperty`	`iOrderIdProperty` Key is "orderId", value is the array of order Id abbreviations.
`protected java.util.Vector`	`iOrderItemAB` Order items to be deleted.
`protected java.lang.String[]`	`iOrderItemId` `Orderitems` Ids.
`protected java.lang.String[]`	`iOutOrderNames` The names of name-value pairs to add to the redirection URL.
`protected java.util.Hashtable`	`iUniqueOrderIdList` Key is resolved order Id, value is "".
`protected java.lang.String[]`	`iValidInputPOrderValues` Valid input order abbreviations.

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext

Fields inherited from interface com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd
defaultCommandClassName, NAME

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

Constructor Summary

Constructors
Constructor and Description

OrderItemDeleteCmdImpl()
Default constructor

Constructors
Constructor and Description
`OrderItemDeleteCmdImpl()` Default constructor

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`buildResourceList()` Build resource list.
`protected void`	`calculateOrder()` Call OrderCalculateCmd to calculate Order
`protected boolean`	`contains(java.util.Vector stringList, java.lang.String searchString)` This method will return if a string is contained in a `Vector` of `String`.
`protected void`	`flush()` flush all `sql` update statements to the database
`protected java.lang.String`	`getCalculateOrder()` Get `calculate Order`
`protected java.lang.String[]`	`getOrderIds()` Return a list of ids of the orders in which at lease one order item has been delete.
`AccessVector`	`getResources()` Gets the resources.
`protected boolean`	`isValidStatus(OrderAccessBean orderAB)` Checks whether the status of the order is valid when you try to delete order items from the order.
`void`	`performExecute()` The main entry point of the command.
`protected void`	`raiseBusinessEvents()` Business auditing probe that will raise the ORDERITEM_CREATION_EVENT for each new `orderitem` created for the quote.
`void`	`reset()` Reset all instance variables.
`protected void`	`resetPriceOverridePrepareFlagsForOrder()` Resets the `price override prepare` flags in the `orderItems` for the Order
`protected void`	`resetSkipRepricingPrepareFlagsForOrder(OrderAccessBean orderAB)` Resets the `SKIP_REPRICING` prepare flag in the `orderItems` for the Order
`protected void`	`setCalculateOrder(java.lang.String a)` Set `Calculate Order`.
`void`	`setCatEntryId(java.lang.String[] ids)` set a list of catalog entry ids to be deleted from the pending orders specified by orderId.
`void`	`setOrderId(java.lang.String[] numbers)` Specifies zero or more orders, using order ids or one of the special abbreviations ".", "", ".t", "t".
`void`	`setOrderItemId(java.lang.String[] numbers)` Set an array of id of order items to be deleted.
`void`	`setOutOrderName(java.lang.String[] names)` Specifies the names of name-value pairs to add to the redirection URL.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` Sets the request properties.
`protected void`	`shipInfoVerify(java.lang.String[] orderIds)` After the delete has taken place ensures that any orphaned ship info records will be deleted.
`protected void`	`unLockOrder(java.lang.String orderId)` Unlocks the order.
`protected void`	`updateBusinessEventData(OrderItemAccessBean orderitemAB)` Capture the business event data
`void`	`validateParameters()` Verify the input parameters.

Methods inherited from class com.ibm.commerce.order.commands.OrderBaseCmdImpl
checkAndCSRLock, checkAndCSRLock, checkAndUnlock, checkAndUnlock, checkAndUnlock, checkAndUnlock, checkLock, checkLock, checkThreshold, getAdminConfigLoader, getOrderLockingHelper, isThresholdAcceptable, lock, lock, lock, lock, thresholdExceeded, unlock, unlock

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - iCatEntryId
```
protected java.lang.String[] iCatEntryId
```
    Catalog entry Ids.
  - iOrderItemId
```
protected java.lang.String[] iOrderItemId
```
    Orderitems Ids.
  - iOrderId
```
protected java.lang.String[] iOrderId
```
    Order ids abbreviations.
  - iOutOrderNames
```
protected java.lang.String[] iOutOrderNames
```
    The names of name-value pairs to add to the redirection URL.
  - iValidInputPOrderValues
```
protected java.lang.String[] iValidInputPOrderValues
```
    Valid input order abbreviations.
  - iOrderIdProperty
```
protected TypedProperty iOrderIdProperty
```
    Key is "orderId", value is the array of order Id abbreviations.
  - iUniqueOrderIdList
```
protected java.util.Hashtable iUniqueOrderIdList
```
    Key is resolved order Id, value is "".
  - iOrderItemAB
```
protected java.util.Vector iOrderItemAB
```
    Order items to be deleted.
- Constructor Detail
  - OrderItemDeleteCmdImpl
```
public OrderItemDeleteCmdImpl()
```
    Default constructor
- Method Detail
  - contains
```
protected boolean contains(java.util.Vector stringList,
               java.lang.String searchString)
```
    This method will return if a string is contained in a Vector of String.
    
    Parameters:
    
    stringList -
    
    searchString -
    
    Returns:
    
    boolean
  - getOrderIds
```
protected java.lang.String[] getOrderIds()
```
    Return a list of ids of the orders in which at lease one order item has been delete. These order ids are also appended to redirection url.
    
    Returns:
    
    an array of order ids
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    Gets the resources.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    resource access vector
    
    Throws:
    
    ECException
  - setCalculateOrder
```
protected void setCalculateOrder(java.lang.String a)
```
    Set Calculate Order.
    
    Parameters:
    
    a - the Calculate Order
  - getCalculateOrder
```
protected java.lang.String getCalculateOrder()
```
    Get calculate Order
    
    Returns:
    
    the Calculate Order
  - isValidStatus
```
protected boolean isValidStatus(OrderAccessBean orderAB)
                         throws ECException,
                                javax.ejb.FinderException,
                                javax.ejb.CreateException,
                                javax.naming.NamingException,
                                java.rmi.RemoteException,
                                java.sql.SQLException
```
    Checks whether the status of the order is valid when you try to delete order items from the order. It returns true if the status is 'P' or 'E' or it's new Quote. Otherwise it returns false.
    
    Parameters:
    
    orderAB - OrderAccessBean
    
    Returns:
    
    boolean
    
    Throws:
    
    ECException
    
    javax.ejb.FinderException
    
    javax.ejb.CreateException
    
    javax.naming.NamingException
    
    java.rmi.RemoteException
    
    java.sql.SQLException
  - performExecute
```
public void performExecute()
                    throws ECException
```
    The main entry point of the command.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - reset
```
public void reset()
```
    Reset all instance variables.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand
  - setCatEntryId
```
public void setCatEntryId(java.lang.String[] ids)
```
    set 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.
    
    Specified by:
    
    setCatEntryId in interface OrderItemDeleteCmd
    
    Parameters:
    
    ids - an array of catalog entry ids.
  - setOrderId
```
public void setOrderId(java.lang.String[] numbers)
```
    Specifies 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 "."
    
    Specified by:
    
    setOrderId in interface OrderItemDeleteCmd
    
    Parameters:
    
    numbers - an array of order ids.
  - setOrderItemId
```
public void setOrderItemId(java.lang.String[] numbers)
```
    Set an array of id of order items to be deleted.
    
    Specified by:
    
    setOrderItemId in interface OrderItemDeleteCmd
    
    Parameters:
    
    numbers - an array of order item ids.
  - setOutOrderName
```
public void setOutOrderName(java.lang.String[] names)
```
    Specifies 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.
    
    Specified by:
    
    setOutOrderName in interface OrderItemDeleteCmd
    
    Parameters:
    
    names - an array of out order names.
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
```
    Sets the request properties.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    
    aRequestProperties - request properties.
    
    Throws:
    
    ECApplicationException
  - unLockOrder
```
protected void unLockOrder(java.lang.String orderId)
                    throws ECException,
                           javax.ejb.FinderException,
                           javax.ejb.CreateException,
                           javax.naming.NamingException,
                           java.rmi.RemoteException,
                           java.sql.SQLException
```
    Unlocks the order.
    
    Parameters:
    
    orderId - order id.
    
    Throws:
    
    ECException
    
    javax.ejb.FinderException
    
    javax.ejb.CreateException
    
    javax.naming.NamingException
    
    java.rmi.RemoteException
    
    java.sql.SQLException
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    Verify the input parameters.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - buildResourceList
```
protected void buildResourceList()
                          throws ECException
```
    Build resource list.
    
    Throws:
    
    ECException
  - shipInfoVerify
```
protected void shipInfoVerify(java.lang.String[] orderIds)
                       throws ECException
```
    After the delete has taken place ensures that any orphaned ship info records will be deleted.
    
    Parameters:
    
    orderIds - The order ids.
    
    Throws:
    
    ECException
  - updateBusinessEventData
```
protected void updateBusinessEventData(OrderItemAccessBean orderitemAB)
                                throws ECSystemException,
                                       java.rmi.RemoteException,
                                       javax.ejb.CreateException,
                                       javax.ejb.FinderException,
                                       javax.naming.NamingException
```
    Capture the business event data
    
    Parameters:
    
    orderitemAB -
    
    Throws:
    
    ECSystemException
    
    java.rmi.RemoteException
    
    javax.ejb.CreateException
    
    javax.ejb.FinderException
    
    javax.naming.NamingException
  - raiseBusinessEvents
```
protected void raiseBusinessEvents()
                            throws javax.ejb.CreateException,
                                   java.rmi.RemoteException,
                                   javax.naming.NamingException,
                                   javax.ejb.FinderException,
                                   ECSystemException
```
    Business auditing probe that will raise the ORDERITEM_CREATION_EVENT for each new orderitem created for the quote.
    
    Throws:
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
    
    ECSystemException
  - resetPriceOverridePrepareFlagsForOrder
```
protected void resetPriceOverridePrepareFlagsForOrder()
                                               throws java.rmi.RemoteException,
                                                      javax.naming.NamingException,
                                                      javax.ejb.FinderException,
                                                      javax.ejb.CreateException,
                                                      ECException
```
    Resets the price override prepare flags in the orderItems for the Order
    
    Throws:
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
    
    javax.ejb.CreateException
    
    ECException
  - resetSkipRepricingPrepareFlagsForOrder
```
protected void resetSkipRepricingPrepareFlagsForOrder(OrderAccessBean orderAB)
                                               throws java.rmi.RemoteException,
                                                      javax.naming.NamingException,
                                                      javax.ejb.FinderException,
                                                      javax.ejb.CreateException,
                                                      ECException
```
    Resets the SKIP_REPRICING prepare flag in the orderItems for the Order
    
    Parameters:
    
    orderAB -
    
    Throws:
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
    
    javax.ejb.CreateException
    
    ECException
  - calculateOrder
```
protected void calculateOrder()
                       throws ECException
```
    Call OrderCalculateCmd to calculate Order
    
    Throws:
    
    ECException
  - flush
```
protected void flush()
              throws ECException
```
    flush all sql update statements to the database
    
    Throws:
    
    ECException

Class OrderItemDeleteCmdImpl

Input parameters:

Output parameters:

Behavior:

Field Summary

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

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

Fields inherited from interface com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.order.commands.OrderBaseCmdImpl

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

Field Detail

COPYRIGHT

iCatEntryId

iOrderItemId

iOrderId

iOutOrderNames

iValidInputPOrderValues

iOrderIdProperty

iUniqueOrderIdList

iOrderItemAB

Constructor Detail

OrderItemDeleteCmdImpl

Method Detail

contains

getOrderIds

getResources

setCalculateOrder

getCalculateOrder

isValidStatus

performExecute

reset

setCatEntryId

setOrderId

setOrderItemId

setOutOrderName

setRequestProperties

unLockOrder

validateParameters

buildResourceList

shipInfoVerify

updateBusinessEventData

raiseBusinessEvents

resetPriceOverridePrepareFlagsForOrder

resetSkipRepricingPrepareFlagsForOrder

calculateOrder

flush