Create a receipt of an item at a fulfillment center. Called by
ReturnItemToInventoryCmd
for Reports.
This task command first determines the type of receipt to be created. If the expected inventory record detail identifier is provided, an expected inventory receipt will be created and the receipt type will be set to 'EIR'. If the disposition record identifier of returned item is provided, a return receipt will be created and the receipt type will be set to 'RTN'. Otherwise, an ad hoc receipt will be created and the receipt type will be set to 'ADHC'.
If this is an expected inventory receipt, the quantity received and quantity remaining of the corresponding expected inventory record detail will be updated.
If the receipt is created successfully, the receipt identifier will be returned and the receipt will be made available to the distribution arrangement by calling MakeReceiptAvailableCmd task command.
This command requires to have the store id set in the command context.
Input Parameters
Output Parameters
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 is "com.ibm.commerce.inventory.commands.CreateReceiptCmdImpl". |
static java.lang.String |
NAME The name of this interface is "com.ibm.commerce.inventory.commands.CreateReceiptCmd". |
Method Summary | |
---|---|
java.lang.String |
getComment1() Gets the comment specified on the new receipt. |
java.lang.String |
getComment2() Gets the comment specified regarding the quality of the item received. |
java.math.BigDecimal |
getCost() Gets the unit cost of the item. |
java.lang.Long |
getDistArrangId() Gets the identifier of the distribution arrangement that has access to this received inventory. |
java.lang.Integer |
getFfmcenterId() Gets the identifier of the fulfillment center where the inventory was received. |
java.lang.Long |
getItemspcId() Gets the identifier of the item specified for receipt. |
java.lang.Long |
getMemberId() Gets the identifier of the owner of the received item. |
java.lang.String |
getPartNumber() Gets the part number of the received item. |
java.lang.Integer |
getQtyReceived() Gets the number of items received. |
java.lang.Long |
getRaDetailId() Gets the expected inventory record detail identifier for the expected inventory receipt. |
java.lang.Long |
getRcptAvailId() Gets the available receipt identifier. |
java.sql.Timestamp |
getReceiptDate() Gets the date the inventory was received. |
java.lang.Long |
getReceiptId() Gets the identifier of the new receipt. |
java.lang.String |
getReceiptType() Gets the type of receipt which indicates how this receipt was created. |
java.lang.Long |
getRtnRcptDspId() Gets the disposition record identifier of the item returned for receipt. |
java.lang.String |
getSetCCurr() Gets the currency of the cost field. |
java.lang.Long |
getVendorId() Gets the identifier of the vendor that supplied the inventory. |
java.lang.Long |
getVersionSpcId() Gets the product version identifier of the item returned for receipt. |
void |
setComment1(java.lang.String newComment1) Sets the comment on the new receipt. |
void |
setComment2(java.lang.String newComment2) Sets the comment regarding the quality of the item received. |
void |
setCost(java.math.BigDecimal newCost) Sets the unit cost of the item being received. |
void |
setDistArrangId(java.lang.Long newDistArrangId) Sets the identifier of the distribution arrangement that has access to this received inventory. |
void |
setFfmcenterId(java.lang.Integer newFfmcenterId) Sets the fulfillment center identifier. |
void |
setItemspcId(java.lang.Long newItemspcId) Sets the identifier of the item specified for receipt. |
void |
setMemberId(java.lang.Long newMemberId) Sets the identifier of the owner of the item specified for receipt. |
void |
setPartNumber(java.lang.String newPartNumber) Sets the part number of the items being received. |
void |
setQtyReceived(java.lang.Integer newQtyReceived) Sets the number of items being received. |
void |
setRaDetailId(java.lang.Long newRaDetailId) Sets the identifier of the record detail of the expected inventory. |
void |
setRcptAvailId(java.lang.Long newRcptAvailId) Sets the identifier of the available receipt. |
void |
setReceiptDate(java.sql.Timestamp newReceiptDate) Sets the date the inventory was received. |
void |
setReceiptId(java.lang.Long newReceiptId) Sets identifier of the new receipt. |
void |
setReceiptType(java.lang.String newReceiptType) Sets the type of receipt which indicates how this receipt was created. |
void |
setRequestProperties(
TypedProperty newRequestProperties) Sets a group of receipt properties. |
void |
setRtnRcptDspId(java.lang.Long newRtnRcptDspId) Sets the disposition record identifier of the returned item. |
void |
setSetCCurr(java.lang.String newSetCCurr) Sets the currency of the cost field. |
void |
setVendorId(java.lang.Long newVendorId) Sets the identifier of the vendor that supplied the inventory. |
void |
setVersionSpcId(java.lang.Long newVersionSpcId)
Sets the product version identifier of the item specified for
receipt. |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String NAME
public static final java.lang.String defaultCommandClassName
Method Detail |
---|
public java.lang.String getComment1()
setComment1(java.lang.String)
public java.lang.String getComment2()
setComment2(java.lang.String)
public java.math.BigDecimal getCost()
setCost(java.math.BigDecimal)
public java.lang.Long getDistArrangId()
setDistArrangId(java.lang.Long)
public java.lang.Integer getFfmcenterId()
setFfmcenterId(java.lang.Integer)
public java.lang.Long getItemspcId()
setItemspcId(java.lang.Long)
public java.lang.Long getMemberId()
setMemberId(java.lang.Long)
public java.lang.String getPartNumber()
setPartNumber(java.lang.String)
public java.lang.Integer getQtyReceived()
setQtyReceived(java.lang.Integer)
public java.lang.Long getRaDetailId()
setRaDetailId(java.lang.Long)
public java.lang.Long getRcptAvailId()
setRcptAvailId(java.lang.Long)
public java.sql.Timestamp getReceiptDate()
setReceiptDate(java.sql.Timestamp)
public java.lang.Long getReceiptId()
setReceiptId(java.lang.Long)
public java.lang.String getReceiptType()
setReceiptType(java.lang.String)
public java.lang.Long getRtnRcptDspId()
setRtnRcptDspId(java.lang.Long)
public java.lang.String getSetCCurr()
cost
field.
setSetCCurr(java.lang.String)
public java.lang.Long getVendorId()
setVendorId(java.lang.Long)
public java.lang.Long getVersionSpcId()
setVersionSpcId(java.lang.Long)
public void setComment1(java.lang.String newComment1)
newComment1
- generic comment, COMMENT1 propertygetComment1()
public void setComment2(java.lang.String newComment2)
newComment2
- quality comment, COMMENT2 propertygetComment2()
public void setCost(java.math.BigDecimal newCost)
newCost
- cost of item, COST propertygetCost()
public void setDistArrangId(java.lang.Long newDistArrangId)
newDistArrangId
- distribution arrangement identifier,
DISTARRANG_ID propertygetDistArrangId()
public void setFfmcenterId(java.lang.Integer newFfmcenterId)
newFfmcenterId
- fulfillment center identifier, FFMCENTER_ID
propertygetFfmcenterId()
public void setItemspcId(java.lang.Long newItemspcId)
newItemspcId
- item specified identifier, ITEMSPC_ID
propertygetItemspcId()
public void setMemberId(java.lang.Long newMemberId)
newMemberId
- member identifier, MEMBER_ID propertygetMemberId()
public void setPartNumber(java.lang.String newPartNumber)
newPartNumber
- part number, PARTNUMBER propertygetPartNumber()
public void setQtyReceived(java.lang.Integer newQtyReceived)
newQtyReceived
- quantity of received items, QTYRECEIVED
propertygetQtyReceived()
public void setRaDetailId(java.lang.Long newRaDetailId)
newRaDetailId
- record detail identifier, RADETAIL_ID
propertygetRaDetailId()
public void setRcptAvailId(java.lang.Long newRcptAvailId)
newRcptAvailId
- available receipt identifiergetRcptAvailId()
public void setReceiptDate(java.sql.Timestamp newReceiptDate)
newReceiptDate
- receipt date, RECEIPTDATE propertygetReceiptDate()
public void setReceiptId(java.lang.Long newReceiptId)
newReceiptId
- new receipt identifier.getReceiptId()
public void setReceiptType(java.lang.String newReceiptType)
newReceiptType
- new receipt type, RECEIPTTYPE propertygetReceiptType()
public void setRtnRcptDspId(java.lang.Long newRtnRcptDspId)
newRtnRcptDspId
- disposition record identifier, RTNRCPTDSP_ID
propertygetRtnRcptDspId()
public void setSetCCurr(java.lang.String newSetCCurr)
cost
field.
newSetCCurr
- currency, SETCCURR propertygetSetCCurr()
public void setVendorId(java.lang.Long newVendorId)
newVendorId
- vendor identifier, VENDOR_ID propertygetVendorId()
public void setVersionSpcId(java.lang.Long newVersionSpcId)
newVersionSpcId
- version identifier, VERSIONSPC_ID
propertygetVersionSpcId()
public void setRequestProperties(TypedProperty newRequestProperties) throws ECApplicationException
newRequestProperties
- receipt properties
ECApplicationException