Metadata-Version: 2.1
Name: odoo-addon-base_confirmation_requirement_rules
Version: 18.0.1.0.0.1
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: Base module to set confirmation requirement rules.
Home-page: https://github.com/sygel-technology/sy-server-tools
License: AGPL-3
Author: Sygel
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

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

===================================
Base Confirmation Requirement Rules
===================================

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

.. |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-sygel--technology%2Fsy--server--tools-lightgray.png?logo=github
    :target: https://github.com/sygel-technology/sy-server-tools/tree/18.0/base_confirmation_requirement_rules
    :alt: sygel-technology/sy-server-tools

|badge1| |badge2| |badge3|

This module allows to set domains in other models types that need to be
met before being validated. This module does nothing on its own and has
to be used along with other modules.

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure this module, you need to:

1. Include users in the group "Skip Confirmation Requirement Rules" so
   requirement rules do not apply when they do a confirmation.

Note: The admin user is included in this group by default. Take this
into account when testing this module.

Usage
=====

To use this module, you need to:

Create another module that inherits this module and uses the 3 provided
mixin models to:

- Create a requirement rule record. Use the
  confirmation_requirement_rule_mixin for that.
- Link the requirement rule to a 'type' record. Use the
  requirement_rule_type_mixin for that.
- Apply the requirements to a record that has the 'type' above. Use the
  confirmation_requirement_mixin for that.

See sale_type_confirmation_requirement_rules of sy-sale-workflow an
example

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

Bugs are tracked on `GitHub Issues <https://github.com/sygel-technology/sy-server-tools/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/sygel-technology/sy-server-tools/issues/new?body=module:%20base_confirmation_requirement_rules%0Aversion:%2018.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
-------

* Sygel

Contributors
------------

- `Sygel <https://www.sygel.es>`__:

  - Manuel Regidor
  - Valentin Vinagre
  - Harald Panten

Maintainers
-----------

This module is part of the `sygel-technology/sy-server-tools <https://github.com/sygel-technology/sy-server-tools/tree/18.0/base_confirmation_requirement_rules>`_ project on GitHub.

You are welcome to contribute.
