Metadata-Version: 2.1
Name: odoo-addon-product_attribute_value_dependent_mixin
Version: 16.0.1.2.0.2
Summary: Mixin to make product attribute values fields on models
Home-page: https://github.com/OCA/product-attribute
Author: Akretion,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.10
Requires-Dist: odoo<16.1dev,>=16.0a

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=======================================
Product Attribute Value Dependent Mixin
=======================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:12dfa656bf593464de4ef8bdaf6570d35c2f32de73e6b802a7294629ca13bd4b
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fproduct--attribute-lightgray.png?logo=github
    :target: https://github.com/OCA/product-attribute/tree/16.0/product_attribute_value_dependent_mixin
    :alt: OCA/product-attribute
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/product-attribute-16-0/product-attribute-16-0-product_attribute_value_dependent_mixin
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/product-attribute&target_branch=16.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This technical module introduces a reusable mixin designed to enable any model to
establish dependencies on specific product attribute values.
By inheriting from this mixin, developers can easily link business rules,
configurations, or records to precise product variants without duplicating complex
filtering logic.

**Table of contents**

.. contents::
   :local:

Usage
=====

Fields
~~~~~~

The mixin exposes the following fields:

-  ``product_tmpl_id``: the product template to filter on (optional).
-  ``product_id``: a specific product variant (optional).
-  ``attribute_value_ids``: a set of attribute values to filter on
   (optional).
-  ``available_product_domain``: a computed domain to restrict the
   selection of ``product_id`` in views, based on ``product_tmpl_id``.
-  ``available_attribute_value_domain``: a computed domain to restrict
   the selection of ``attribute_value_ids`` in views, based on
   ``product_tmpl_id``.

Inheriting the Mixin
~~~~~~~~~~~~~~~~~~~~

To use this mixin, inherit from ``attribute.value.dependent.mixin`` in
your model alongside your base model:

.. code:: python

   from odoo import fields, models


   class MyModel(models.Model):
       _name = "my.model"
       _inherit = ["my.model", "attribute.value.dependent.mixin"]

All fields from the mixin (``product_tmpl_id``, ``product_id``,
``attribute_value_ids``, ``available_product_domain``,
``available_attribute_value_domain``) are automatically available on
your model.

Using the Domain Fields in a Form View
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The computed domain fields must be referenced in the ``domain``
attribute of the corresponding fields in the view. Odoo 18.0
automatically loads fields referenced in ``domain`` attributes, so no
additional declaration is needed.

.. code:: xml

   <record id="view_my_model_form" model="ir.ui.view">
       <field name="name">my.model.form</field>
       <field name="model">my.model</field>
       <field name="arch" type="xml">
           <form>
               <group>
                   <field name="product_tmpl_id"/>
                   <field name="product_id"
                          domain="available_product_domain"
                          context="{'default_product_tmpl_id': product_tmpl_id}"/>
                   <field name="attribute_value_ids"
                          domain="available_attribute_value_domain"
                          widget="many2many_tags"/>
               </group>
           </form>
       </field>
   </record>

Matching Logic
~~~~~~~~~~~~~~

The ``is_matching_product(product)`` method validates whether a given
product variant satisfies the configured constraints. All fields are
optional and act as independent filters combined with AND logic:

-  If ``product_id`` is set, it is the most restrictive criterion: the
   method returns ``True`` only if the given product is exactly that
   variant, regardless of other fields.
-  If ``product_tmpl_id`` is set, the given product must belong to that
   template.
-  If ``attribute_value_ids`` is set, the given product must match the
   configured attribute values with the following logic:

   -  Values belonging to the **same attribute** are combined with
      **OR** (e.g. size S *or* M).
   -  Values belonging to **different attributes** are combined with
      **AND** (e.g. size S or M *and* color Red).
   -  Since an attribute value can exist across multiple templates,
      ``product_tmpl_id`` and ``attribute_value_ids`` should be used
      together to avoid unintended matches across templates.

-  If no field is set, the method returns ``True`` for any product (no
   constraint).

Using ``is_matching_product``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``is_matching_product(product)`` method can be called from Python
code to check whether a given ``product.product`` record satisfies the
constraints defined on a mixin record:

.. code:: python

   for rule in self.env["my.model"].search([]):
       if rule.is_matching_product(product):
           # apply rule

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/product-attribute/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 <https://github.com/OCA/product-attribute/issues/new?body=module:%20product_attribute_value_dependent_mixin%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
~~~~~~~

* Akretion

Contributors
~~~~~~~~~~~~

* `Akretion <https://www.akretion.com>`_

  * Chafique Delli <chafique.delli@akretion.com>
  * Guillaume Masson <guillaume.masson@akretion.com>

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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/product-attribute <https://github.com/OCA/product-attribute/tree/16.0/product_attribute_value_dependent_mixin>`_ project on GitHub.

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