# Stock Putaway Hooks

Technical module. It adds hooks to the core putaway method `StockLocation._get_putaway_strategy()` allowing to plug other strategies and makes the selector fields in the tree views dynamic (required/readonly). See the usage section for details.

An example of implementation is the module `stock_putaway_by_route`.

Table of contents

- Usage
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

# Usage

The modules that implement a new strategy have to follow the following steps. The module `stock_putaway_by_route` should be used as reference.

Add the field to match on `stock.putaway.rule` in the model and in the view. In the view, the field must have `options="{'exclusive_selection': True}"`, which will allow this module to dynamically build dynamic attrs, restricting the selection of more than one field. (defining the readonly and required attrs in the view is therefore useless).

Add the strategy key, named after the new field name, in `StockLocation._putaway_strategies`. Example:

    class StockLocation(models.Model):
        _inherit = "stock.location"

        @property
        def _putaway_strategies(self):
            strategies = super()._putaway_strategies
            return strategies + ["route_id"]

Pass the value to match with the putaway rule field in the context, in every method calling `StockLocation._get_putaway_strategy`. The name of the key in the context is:`_putaway_<KEY>`, where KEY is the name of the new field on the putaway rule. The value can be a unit, a recordset of any length or a list/tuple. In latter cases, the putaway rule is selected if its field match any value in the list/recordset.

# Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

# Credits

## Authors

- Camptocamp

## Contributors

- Guewen Baconnier <guewen.baconnier@camptocamp.com>
- Fernando La Chica <fernandolachica@gmail.com>
- Denis Roussel <denis.roussel@acsone.eu>

## Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/stock-logistics-workflow project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.