com.ibm.commerce.inventory.commands
Interface MakeReceiptAvailableCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
MakeReceiptAvailableCmdImpl

public interface MakeReceiptAvailableCmd
extends TaskCommand

Make a receipt available to the distribution arrangement.

This is done by inserting a row into rcptavail table associating the receipt with the distribution arrangement.

The distribution arrangement will have a picking method of either LIFO or FIFO. If the picking method of the distribution arrangment is FIFO, the precedence of the rcptavail row will be MAX(precedence)+1. If the picking method of the distribution arrangment is LIFO, the precedence of the rcptavail row will be MIN(precedence)-1. If there are no rows in the rcptavail table, the precedence of the rcptavail row will be 1.

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

Input Parameters

distArrangId
Identifier of the distribution arrangement that have access to this received inventory.
itemspcId
Identifier of the received item. This will be used to find the distribution arrangement if distArrangId is not provided.
receiptId
Return the identifer of the new receipt.

Output Parameters

rcptAvailId
Returns the available receipt identifier.

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.MakeReceiptAvailableCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.MakeReceiptAvailableCmd".
 
Method Summary
 java.lang.Long getDistArrangId()
          Return distribution arrangement identifier.
 java.lang.Long getItemspcId()
          Return item identifier.
 java.lang.Long getRcptAvailId()
          Return available receipt identifier.
 java.lang.Long getReceiptId()
          Return the receipt identifier.
 void setDistArrangId(java.lang.Long newDistArrangId)
          Set distribution arrangement identifier.
 void setItemspcId(java.lang.Long newItemspcId)
          Set item identifier.
 void setRcptAvailId(java.lang.Long newRcptAvailId)
          Set available receipt identifier.
 void setReceiptId(java.lang.Long newReceiptId)
          Set the receipt identifier.
 void setRequestProperties(TypedProperty newRequestProperties)
          Set request properties.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.inventory.commands.MakeReceiptAvailableCmdImpl".

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.inventory.commands.MakeReceiptAvailableCmd".
Method Detail

getDistArrangId

public java.lang.Long getDistArrangId()
Return distribution arrangement identifier.
Returns:
java.lang.Long

getItemspcId

public java.lang.Long getItemspcId()
Return item identifier.
Returns:
java.lang.Long

getRcptAvailId

public java.lang.Long getRcptAvailId()
Return available receipt identifier.
Returns:
java.lang.Long

getReceiptId

public java.lang.Long getReceiptId()
Return the receipt identifier.
Returns:
java.lang.Long

setDistArrangId

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

setItemspcId

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

setRcptAvailId

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

setReceiptId

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

setRequestProperties

public void setRequestProperties(TypedProperty newRequestProperties)
                          throws ECApplicationException
Set request properties.
Parameters:
reqParms - com.ibm.commerce.datatype.TypedProperty