com.ibm.commerce.inventory.commands
Interface GeneratePickBatchCmd

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

public interface GeneratePickBatchCmd
extends TaskCommand

Generate a pick batch for specified fulfillment center and store.

The order releases with 'SHIP' status for the specified fulfillment center and store will be included in the pick batch generation. If there are more than the maximum number of eligible order releases when a pick batch is generated, only the maximum number of order releases are picked up in this pick batch and the rest will be picked up by the next pick batch generation. A pack slip XML will be generated for each eligible order release and a pick ticket XML will be generated for the whole batch. An invoice XML may also be generated for each eligible order release.

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

Input Parameters

ffmcenterId
The identifier of the fulfillment center this pick batch is generated on.

Output Parameters

moreOrderReleases
Return the flag to indicate if there are still more eligible order releases not included in this pick batch.
pickbatchId
Return the identifier of the new pick batch.

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.GeneratePickBatchCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.GeneratePickBatchCmd".
 
Method Summary
 java.lang.Integer getFfmcenterId()
          Return fulfillment center identifier.
 java.lang.Integer getLanguageId()
          Return language identifier.
 int getMaxOrdReleasesPerPickbatch()
          Return the maximum number of order releases included in a pick batch.
 java.lang.String getMoreOrderReleases()
          Return the flag to indicate if there are more eligible order releases not included in this pick batch.
 java.lang.Long getPickBatchId()
          Return the pick batch identifier.
 java.lang.Integer getStoreentId()
          Return the store entity identidier.
 void setFfmcenterId(java.lang.Integer newFfmcenterId)
          Set fulfillment center identifier.
 void setLanguageId(java.lang.Integer newLanguageId)
          Set language identifier.
 void setMaxOrdReleasesPerPickbatch(int newMaxOrdReleasesPerPickbatch)
          Set the maximum number of order releases included in a pick batch.
 void setMoreOrderReleases(java.lang.String newMoreOrderReleases)
          Return the flag to indicate if there are more eligible order releases not included in this pick batch.
 void setPickBatchId(java.lang.Long newPickBatchId)
          Set the pick batch identifier.
 void setRequestProperties(TypedProperty newRequestProperties)
          Set request properties.
 void setStoreentId(java.lang.Integer newStoreentId)
          Set the store entity identifier.
 
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.GeneratePickBatchCmdImpl".

NAME

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

getFfmcenterId

public java.lang.Integer getFfmcenterId()
Return fulfillment center identifier.
Returns:
java.lang.Integer

getLanguageId

public java.lang.Integer getLanguageId()
Return language identifier.
Returns:
java.lang.Integer

getMaxOrdReleasesPerPickbatch

public int getMaxOrdReleasesPerPickbatch()
Return the maximum number of order releases included in a pick batch.
Returns:
int

getMoreOrderReleases

public java.lang.String getMoreOrderReleases()
Return the flag to indicate if there are more eligible order releases not included in this pick batch.
Returns:
java.lang.String

getPickBatchId

public java.lang.Long getPickBatchId()
Return the pick batch identifier.
Returns:
java.lang.Long

getStoreentId

public java.lang.Integer getStoreentId()
Return the store entity identidier.
Returns:
java.lang.Integer

setFfmcenterId

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

setLanguageId

public void setLanguageId(java.lang.Integer newLanguageId)
Set language identifier.
Parameters:
newLanguageId - java.lang.Integer

setMaxOrdReleasesPerPickbatch

public void setMaxOrdReleasesPerPickbatch(int newMaxOrdReleasesPerPickbatch)
Set the maximum number of order releases included in a pick batch.
Parameters:
newMaxOrdReleasesPerPickbatch - int

setMoreOrderReleases

public void setMoreOrderReleases(java.lang.String newMoreOrderReleases)
Return the flag to indicate if there are more eligible order releases not included in this pick batch.
Parameters:
newMoreOrderReleases - java.lang.String

setPickBatchId

public void setPickBatchId(java.lang.Long newPickBatchId)
Set the pick batch identifier.
Parameters:
newPickBatchId - java.lang.Long

setRequestProperties

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

setStoreentId

public void setStoreentId(java.lang.Integer newStoreentId)
Set the store entity identifier.
Parameters:
newStoreentId - java.lang.Integer