com.ibm.commerce.inventory.commands

Interface GeneratePickBatchCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, 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 order releases, which are eligible, 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 Detail

      • COPYRIGHT

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

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

        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

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

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

        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)
      • getStoreentId

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

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

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

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

        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

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

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

        java.lang.String parsePackslipForDtd10(java.lang.String packSlipXML)
                                        throws ECApplicationException
        Generate pack slip for dtd1.0 by parsing the pack slip for dtd2.0 This method is called by PickPackListResult.jsp
        Parameters:
        packSlipXML - the pack slip XML for dtd2.0
        Returns:
        pack slip XML for dtd1.0
        Throws:
        ECApplicationException - if any exception occurs while parsing the XML
      • parsePickSlipForDtd10

        java.lang.String parsePickSlipForDtd10(java.lang.String pickSlipXML)
                                        throws ECApplicationException
        Generate pick ticket for dtd1.0 by parsing the pick ticket for dtd2.0 This method is called by PickPackListResult.jsp
        Parameters:
        pickSlipXML - the pick slip XML for dtd2.0
        Returns:
        pick ticket XML for dtd1.0
        Throws:
        ECApplicationException - if any exception occurs while parsing the XML