com.ibm.commerce.inventory.commands
Interface ReceiptCreateCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, ToolsControllerCommand
All Known Implementing Classes:
ReceiptCreateCmdImpl

public interface ReceiptCreateCmd
extends ToolsControllerCommand

Creates an expected inventory receipt or ad hoc receipt. If the expected inventory record detail identifier is provided, an expected inventory receipt will be created. Otherwise, an ad hoc receipt will be created.

This controller command will call CreateReceiptCmd to create the receipt and insert a new row in itemffmctr table for this item, store and fulfillment center if row does not yet exist when a receipt is created. This row will be used to record information about reserved quantities, amount on backorder, and amount allocated to backorders for this item owned by this store at this fulfillment center.

This command requires to have the store id set in the command context.

Parameters

EC_XMLObject
An input xml_string that contains all required data for creating new expected inventory receipt.

Example xml_string for expected inventory receipt:

 <?xml version="1.0" encoding="UTF-8"?>
 <XML>
 <XMLFile>inventory.POReceiveInventoryDialog</XMLFile>
 <comment1>Receipt comment</comment1>
 <comment2>Quality comment</comment2>
 <cost>24.5</cost>
 <ffmcenterId>300</ffmcenterId>
 <qtyReceived>230</qtyReceived>
 <raDetailId>10001</raDetailId>
 <receiptDate>2001-10-23 00:00:00.0</receiptDate>
 <setCCurr>CAD</setCCurr> 
 <vendorId>200</vendorId>
 </XML>
 

Example xml_string for ad hoc receipt:

 <?xml version="1.0" encoding="UTF-8"?>
 <XML>
 <XMLFile>inventory.POReceiveInventoryDialog</XMLFile>
 <comment1>Receipt comment</comment1>
 <comment2>Quality comment</comment2>
 <cost>24.5</cost>
 <setCCurr>CAD</setCCurr>
 <ffmcenterId>300</ffmcenterId>
 <itemspcId>400</itemspcId>
 <qtyReceived>230</qtyReceived>
 <receiptDate>2001-10-23 00:00:00.0</receiptDate>
 <setCCurr>CAD</setCCurr>
 <vendorId>200</vendorId>
 </XML>

URL
The URL to be called when the command completes successfully.

Response Parameters

receiptId
Return the identifer of the new receipt.
receiptType
Return the type of the receipt which indicates how this receipt was created. (ADHC: Ad hoc receipt, EIR: Expected Inventory Receipt)

Exceptions

When the required fields are missing or not in the right data type, this command will throw exception to indicate which field is missing or bad.


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class name is "com.ibm.commerce.inventory.commands.ReceiptCreateCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.ReceiptCreateCmd".
 
Method Summary
 void setComment1(java.lang.String newComment1)
          Sets comment1 (receipt comment).
 void setComment2(java.lang.String newComment2)
          Sets comment2 (quality comment).
 void setCost(java.lang.String newCost)
          Sets unit cost.
 void setDistArrangId(java.lang.String newDistArrangId)
          Sets distribution arrangement identifier.
 void setFfmcenterId(java.lang.String newFfmcenterId)
          Sets fulfillment center identifier.
 void setItemspcId(java.lang.String newItemspcId)
          Sets item identifier.
 void setMemberId(java.lang.String newMemberId)
          Sets member identifier.
 void setPartNumber(java.lang.String newPartNumber)
          Sets the part number.
 void setQtyReceived(java.lang.String newQtyReceived)
          Sets the quantity received.
 void setRaDetailId(java.lang.String newRaDetailId)
          Sets expected inventory record detail identifier.
 void setRcptAvailId(java.lang.String newRcptAvailId)
          Sets available receipt identifier.
 void setReceiptDate(java.lang.String newReceiptDate)
          Sets the date the inventory was received.
 void setReceiptId(java.lang.String newReceiptId)
          Sets the receipt identifier.
 void setReceiptType(java.lang.String newReceiptType)
          Sets type of receipt which indicates how this receipt was created.
 void setRtnRcptDspId(java.lang.String newRtnRcptDspId)
          Sets the disposition record identifier of returned item.
 void setSetCCurr(java.lang.String newSetCCurr)
          Sets currency of the COST field.
 void setVendorId(java.lang.String newVendorId)
          Sets the identifier of the vendor that supplied the inventory.
 void setVersionSpcId(java.lang.String newVersionSpcId)
          Sets the product version identifier of the item.
 
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.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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.inventory.commands.ReceiptCreateCmd".
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name is "com.ibm.commerce.inventory.commands.ReceiptCreateCmdImpl".
See Also:
Constant Field Values
Method Detail

setComment1

public void setComment1(java.lang.String newComment1)
Sets comment1 (receipt comment).
Parameters:
newComment1 - comment

setComment2

public void setComment2(java.lang.String newComment2)
Sets comment2 (quality comment).
Parameters:
newComment2 - comment

setCost

public void setCost(java.lang.String newCost)
Sets unit cost.
Parameters:
newCost - unit cost

setDistArrangId

public void setDistArrangId(java.lang.String newDistArrangId)
Sets distribution arrangement identifier.
Parameters:
newDistArrangId - distribution arrangement identifier

setFfmcenterId

public void setFfmcenterId(java.lang.String newFfmcenterId)
Sets fulfillment center identifier.
Parameters:
newFfmcenterId - fulfillment center identifier

setItemspcId

public void setItemspcId(java.lang.String newItemspcId)
Sets item identifier.
Parameters:
newItemspcId - item identifier

setMemberId

public void setMemberId(java.lang.String newMemberId)
Sets member identifier.
Parameters:
newMemberId - owner identifier

setPartNumber

public void setPartNumber(java.lang.String newPartNumber)
Sets the part number.
Parameters:
newPartNumber - part number

setQtyReceived

public void setQtyReceived(java.lang.String newQtyReceived)
Sets the quantity received.
Parameters:
newQtyReceived - quantity received

setRaDetailId

public void setRaDetailId(java.lang.String newRaDetailId)
Sets expected inventory record detail identifier.
Parameters:
newRaDetailId - record detail identifier

setRcptAvailId

public void setRcptAvailId(java.lang.String newRcptAvailId)
Sets available receipt identifier.
Parameters:
newRcptAvailId - available receipt identifier

setReceiptDate

public void setReceiptDate(java.lang.String newReceiptDate)
Sets the date the inventory was received.
Parameters:
newReceiptDate - date inventory was received

setReceiptId

public void setReceiptId(java.lang.String newReceiptId)
Sets the receipt identifier.
Parameters:
newReceiptId - receipt identifier

setReceiptType

public void setReceiptType(java.lang.String newReceiptType)
Sets type of receipt which indicates how this receipt was created.
Parameters:
newReceiptType - receipt type

setRtnRcptDspId

public void setRtnRcptDspId(java.lang.String newRtnRcptDspId)
Sets the disposition record identifier of returned item.
Parameters:
newRtnRcptDspId - return receipt disposition identifier

setSetCCurr

public void setSetCCurr(java.lang.String newSetCCurr)
Sets currency of the COST field.
Parameters:
newSetCCurr - currency

setVendorId

public void setVendorId(java.lang.String newVendorId)
Sets the identifier of the vendor that supplied the inventory.
Parameters:
newVendorId - vendor identifier

setVersionSpcId

public void setVersionSpcId(java.lang.String newVersionSpcId)
Sets the product version identifier of the item.
Parameters:
newVersionSpcId - version identifier