public interface CreateReceiptCmd extends TaskCommand
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.
Modifier and Type | Field and Description |
---|---|
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".
|
Modifier and Type | Method and Description |
---|---|
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.
|
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
static final java.lang.String defaultCommandClassName
java.lang.String getComment1()
java.lang.String getComment2()
java.math.BigDecimal getCost()
java.lang.Long getDistArrangId()
java.lang.Integer getFfmcenterId()
java.lang.Long getItemspcId()
java.lang.Long getMemberId()
java.lang.String getPartNumber()
java.lang.Integer getQtyReceived()
java.lang.Long getRaDetailId()
java.lang.Long getRcptAvailId()
java.sql.Timestamp getReceiptDate()
java.lang.Long getReceiptId()
java.lang.String getReceiptType()
java.lang.Long getRtnRcptDspId()
java.lang.String getSetCCurr()
java.lang.Long getVendorId()
java.lang.Long getVersionSpcId()
void setComment1(java.lang.String newComment1)
void setComment2(java.lang.String newComment2)
void setCost(java.math.BigDecimal newCost)
void setDistArrangId(java.lang.Long newDistArrangId)
void setFfmcenterId(java.lang.Integer newFfmcenterId)
void setItemspcId(java.lang.Long newItemspcId)
void setMemberId(java.lang.Long newMemberId)
void setPartNumber(java.lang.String newPartNumber)
void setQtyReceived(java.lang.Integer newQtyReceived)
void setRaDetailId(java.lang.Long newRaDetailId)
void setRcptAvailId(java.lang.Long newRcptAvailId)
void setReceiptDate(java.sql.Timestamp newReceiptDate)
void setReceiptId(java.lang.Long newReceiptId)
void setReceiptType(java.lang.String newReceiptType)
void setRtnRcptDspId(java.lang.Long newRtnRcptDspId)
void setSetCCurr(java.lang.String newSetCCurr)
void setVendorId(java.lang.Long newVendorId)
void setVersionSpcId(java.lang.Long newVersionSpcId)
void setRequestProperties(TypedProperty newRequestProperties) throws ECApplicationException