com.ibm.commerce.inventory.commands
Interface ReceiptCreateCmd

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

public interface ReceiptCreateCmd
extends ToolsControllerCommand

Create 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 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
           
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
           
 
Method Summary
 void setComment1(java.lang.String newComment1)
          Set comment1 (receipt comment).
 void setComment2(java.lang.String newComment2)
          Set comment2 (quality comment).
 void setCost(java.lang.String newCost)
          Set unit cost.
 void setDistArrangId(java.lang.String newDistArrangId)
          Set distribution arrangement identifier.
 void setFfmcenterId(java.lang.String newFfmcenterId)
          Set fulfillment center identifier.
 void setItemspcId(java.lang.String newItemspcId)
          Set item identifier.
 void setMemberId(java.lang.String newMemberId)
          Set member identifier.
 void setPartNumber(java.lang.String newPartNumber)
          Set part number.
 void setQtyReceived(java.lang.String newQtyReceived)
          Set the quantity received.
 void setRaDetailId(java.lang.String newRaDetailId)
          Set expected inventory record detail identifier.
 void setRcptAvailId(java.lang.String newRcptAvailId)
          Set available receipt identifier.
 void setReceiptDate(java.lang.String newReceiptDate)
          Set the date the inventory was received.
 void setReceiptId(java.lang.String newReceiptId)
          Set the receipt identifier.
 void setReceiptType(java.lang.String newReceiptType)
          Set type of receipt which indicates how this receipt was created.
 void setRtnRcptDspId(java.lang.String newRtnRcptDspId)
          Set the disposition record identifier of returned item.
 void setSetCCurr(java.lang.String newSetCCurr)
          Set currency of the COST field.
 void setVendorId(java.lang.String newVendorId)
          Set the identifier of the vendor that supplied the inventory.
 void setVersionSpcId(java.lang.String newVersionSpcId)
          Set the product version identifier of the item.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name.

NAME

public static final java.lang.String NAME
Method Detail

setComment1

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

setComment2

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

setCost

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

setDistArrangId

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

setFfmcenterId

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

setItemspcId

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

setMemberId

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

setPartNumber

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

setQtyReceived

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

setRaDetailId

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

setRcptAvailId

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

setReceiptDate

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

setReceiptId

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

setReceiptType

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

setRtnRcptDspId

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

setSetCCurr

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

setVendorId

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

setVersionSpcId

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