com.ibm.commerce.inventory.commands
Interface GeneratePickBatchCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
GeneratePickBatchCmdImpl

public interface GeneratePickBatchCmd
extends TaskCommand

Generates 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 task 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()
          Returns fulfillment center identifier.
 java.lang.Integer getLanguageId()
          Returns language identifier.
 int getMaxOrdReleasesPerPickbatch()
          Returns the maximum number of order releases included in a pick batch.
 java.lang.String getMoreOrderReleases()
          Returns the flag to indicate if there are more eligible order releases not included in this pick batch.
 java.lang.Long getPickBatchId()
          Returns the pick batch identifier.
 java.lang.Integer getStoreentId()
          Returns the store entity identidier.
 void setFfmcenterId(java.lang.Integer newFfmcenterId)
          Sets fulfillment center identifier.
 void setLanguageId(java.lang.Integer newLanguageId)
          Sets language identifier.
 void setMaxOrdReleasesPerPickbatch(int newMaxOrdReleasesPerPickbatch)
          Sets the maximum number of order releases included in a pick batch.
 void setMoreOrderReleases(java.lang.String newMoreOrderReleases)
          Returns the flag to indicate if there are more eligible order releases not included in this pick batch.
 void setPickBatchId(java.lang.Long newPickBatchId)
          Sets the pick batch identifier.
 void setRequestProperties( TypedProperty newRequestProperties)
          Sets request properties.
 void setStoreentId(java.lang.Integer newStoreentId)           Sets the store entity identifier.
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.inventory.commands.GeneratePickBatchCmd".
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.inventory.commands.GeneratePickBatchCmdImpl".
See Also:
Constant Field Values
Method Detail

getFfmcenterId

public java.lang.Integer getFfmcenterId()
Returns fulfillment center identifier.
Returns:
Fulfillment center id.
See Also:
setFfmcenterId(java.lang.Integer)

getLanguageId

public java.lang.Integer getLanguageId()
Returns language identifier.
Returns:
Language id.
See Also:
setLanguageId(java.lang.Integer)

getMaxOrdReleasesPerPickbatch

public int getMaxOrdReleasesPerPickbatch()
Returns the maximum number of order releases included in a pick batch.
Returns:
Maximum releases allowed in a pick batch.
See Also:
setMaxOrdReleasesPerPickbatch(int)

getMoreOrderReleases

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

getPickBatchId

public java.lang.Long getPickBatchId()
Returns the pick batch identifier.
Returns:
Pick batch id.
See Also:
setPickBatchId(java.lang.Long)

getStoreentId

public java.lang.Integer getStoreentId()
Returns the store entity identidier.
Returns:
Store entity identifier.
See Also:
setStoreentId(java.lang.Integer)

setFfmcenterId

public void setFfmcenterId(java.lang.Integer newFfmcenterId)
Sets fulfillment center identifier.
Parameters:
newFfmcenterId - fulfillment center id
See Also:
getFfmcenterId()

setLanguageId

public void setLanguageId(java.lang.Integer newLanguageId)
Sets language identifier.
Parameters:
newLanguageId - language id
See Also:
getLanguageId()

setMaxOrdReleasesPerPickbatch

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

setMoreOrderReleases

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

setPickBatchId

public void setPickBatchId(java.lang.Long newPickBatchId)
Sets the pick batch identifier.
Parameters:
newPickBatchId - pick batch id
See Also:
getPickBatchId()

setStoreentId

public void setStoreentId(java.lang.Integer newStoreentId)
Sets the store entity identifier.
Parameters:
newStoreentId - store id
See Also:
getStoreentId()

setRequestProperties

public void setRequestProperties(TypedProperty newRequestProperties)
                          throws ECApplicationException
Sets request properties.
Parameters:
newRequestProperties - request properties
ECApplicationException