#####################
Classes documentation
#####################

Here you can found technical documentation about the implementation code of this API.

* `Controllers Package`_
* `Exception Package`_
* `Implementation Package`_

  * `Implementation.XXX Package`_

* `Models Package`_

!!!!

!!!!

Controllers Package
===================

The ``Controller`` package contains controllers used to handle HTTP request.

.. image:: uml/classes/images/Controllers.png

.. dropdown:: XXXController Class
   :icon: telescope-fill
   :color: primary


   The ``XXXController`` class is a SpringBoot Controller responsible for handling
   HTTP GET requests to the ``<name of the endpoint>`` endpoint. It ...

   It has **two** variables :

   * ``logger`` : The local logger.
   * ``service`` : An instance of ``XXXService`` service, responsible for ...

   The class contains **one** constructor :

   .. dropdown:: ``XXXController`` - Instantiates the controller with the necessary dependencies
      :icon: gear

      The ``XXXController`` constructor is used to **instantiate the service** that will process requests to ...

      It initialize the ``service`` variable with the provided XXXService instance.

      The constructor requires **one** parameter :

      * ``service`` : An instance of the ``XXXService`` service, which handles the logic for ...

      It doesn’t return anything.

   It also includes **one** public method :

   .. dropdown:: ``<name of the method>`` - <short description of the method>.
      :icon: gear

      The ``<name of the method>`` public method handles HTTP <method> requests directed to the ``<name of the endpoint>`` endpoint.
      It ...

      It follows these steps :

      1.
      2.
      3.

      This method requires **<number>** parameters :

      * ``<name of the parameter>`` : ...

      It returns ...

!!!!

Exception Package
=================

The ``Exception`` package contains exceptions that can be thrown by the application.

.. image:: uml/classes/images/Exception.png

.. dropdown:: XXXException Class
   :icon: telescope-fill
   :color: primary


   The ``XXXException`` class is a custom exception used to
   indicate that ... It is thrown when ...

   It has **one** variable :

   * ``serialVersionUID`` : The default serial version UID used for serialization.

   The class includes **one** constructor :

   .. dropdown:: ``XXXException`` - Instantiates the exception with a specified detail message
      :icon: gear

      The constructor **initializes** the exception with a detail message explaining the reason for the exception.

      The constructor requires **one** parameter :

      * ``errorMessage``: A ``String`` containing the detail message that explains why the exception is thrown.

      It doesn’t return anything.

.. dropdown:: GlobalExceptionHandler Class
   :icon: telescope-fill
   :color: primary


   The ``GlobalExceptionHandler`` class is **a global exception handler**
   for all controllers in the application. It handles specific exceptions
   that may occur during the execution of controller methods, providing a
   centralized mechanism for error handling and consistent responses across
   the application.

   It has **one** variable :

   * ``logger`` : The local logger

   The class includes **<number>** exception handling methods :

   .. dropdown:: ``handleXXXException`` - Handles XXXException exceptions.
      :icon: gear

      This method handles ``XXXException`` exceptions that are thrown by any controller method in the application.
      It **returns ...** along with an error message.

      It logs the exception with a message indicating a <HTTP Status Code> status and returns the exception message in the HTTP response.

      The method requires **one** parameter :

      * ``ex`` : The exception instance that was thrown.

      It returns a <HTTP Status Code> response status along with an error message.

!!!!

Implementation Package
======================

The ``Implementation`` package contains the core of the application.

Implementation.XXX Package
~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``Implementation.XXX`` package contains the ... classes.

.. image:: uml/classes/images/ImplementationXXX.png

Implementation.XXX.YYY Package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``Implementation.XXX.YYY`` package contains ...

.. dropdown:: XXX Class
   :icon: telescope-fill
   :color: primary


   ``XXX`` is an abstract class designed to ...
   It has one direct subclass, ``...``.

   It has **one** variable :

   * ``logger`` : The local logger

   The class includes **<number>** public abstract method, implemented in the subclasses :

   .. dropdown:: ``<name of the method>`` - <short description of the method>
      :icon: gear

      The method ``<name of the method>`` ...

      It is implemented in :

      * `YYY Class`_ : To ...

.. dropdown:: YYY Class
   :icon: telescope-fill
   :color: primary
   :name: YYY Class


   ``YYY Class`` is a subclass of the ``XXX`` abstract class.
   It is responsible for ...

   It has **<number>** variable :

   * ``<variable>`` : ...

   The class includes **<number>** public method, implementing a parent abstract method :

   .. dropdown:: ``<name of the method>`` - <short description of the method>
      :icon: gear

      This implementation of the abstract method ``<name of the method>`` is responsible for ...

      It follow these steps :

      1.
      2.
      3.

      The method doesn't require any parameter.

      It returns ...

!!!!

Implementation.XXX Package
~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``Implementation.XXX`` package contains the ... classes.

.. image:: uml/classes/images/ImplementationXXX.png

.. dropdown:: XXX Interface
   :icon: telescope-fill
   :color: primary


   The ``XXX`` interface serves as ...
   It provides methods for ...

   The interface defines **<number>** methods to implement :

   .. dropdown:: ``<name of the method>`` - <short description of the method>
      :icon: gear

      The method ``<name of the method>`` ...

      It is implemented in :

      * `YYY Class`_ : ...


.. dropdown:: YYY Class (Implements XXX Interface)
   :icon: telescope-fill
   :color: primary
   :name: YYY Class


   The ``YYY Class`` implements the ``XXX`` interface.

   The class includes **<number>** public methods, implementing methods from an interface :

   .. dropdown:: ``<name of the method>`` - <short description of the method>
      :icon: gear

      This implementation of the interface method ``<name of the method>`` is responsible ...

      It follows these steps :

      1.
      2.
      3.

      This method requires **<number>** parameters :

      * ``<parameter>`` : ...

      It returns ...

Implementation.Services Package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``Implementation.Services`` package contains the services used in the application.

.. image:: uml/classes/images/ImplementationServices.png

.. dropdown:: XXXService Class
   :icon: telescope-fill
   :color: primary


   The ``XXXService`` class is a service use ...

   It has **<number>** variables :

     * ``logger`` : The local logger.
     * ``<variable>`` : ...

   The class contains **one** constructor :

   .. dropdown:: ``XXXService`` - Instantiates the service with the necessary dependencies
      :icon: gear

      The ``XXXService`` constructor ...

      The constructor requires **<number>** parameters :

      * ``<parameter>`` : The ``...`` instance used to ...

      It doesn’t return anything.

   It includes **<number>** public methods :

   .. dropdown:: ``<name of the method>`` - <short description of the method>
      :icon: gear

      The method ``<name of the method>`` ...

      It follows these steps :

      1.
      2.
      3.

      This method requires **<number>** parameters :

      * ``<parameter>`` :

      It returns ...

   It also includes **<number>** private methods :

   .. dropdown:: ``<name of the method>`` - <short description of the method>
      :icon: gear

      The method ``<name of the method>`` ...

      It requires **<number>** parameters :

      * ``<parameter`` :

      It doesn’t return anything.

!!!!

Models Package
==============

The ``Models`` package contains the models used in the application.

.. image:: uml/classes/images/Models.png

Models.Objects Package
~~~~~~~~~~~~~~~~~~~~~~

The ``Models.Objects`` package contains the object models used in the application.

.. dropdown:: XXX Object
   :icon: telescope-fill
   :color: primary
   :name: XXX


   The ``XXX`` class is ...

   This object contains the following attributes :

   .. list-table::
      :header-rows: 1
      :widths: auto

      * - **Attribute**
        - **Description**
        - **Type**
      * - ``Attribute``
        - Description
        - ``Type``

Models.Enums Package
~~~~~~~~~~~~~~~~~~~~

The ``Models.Enums`` package contains the enum models used in the application.

.. dropdown:: XXX Enum
   :icon: telescope-fill
   :color: primary


   The ``XXX`` enumeration ...

   This enum currently includes ... :

   * ``enum`` : Represents ...

   It includes **one** variable :

   * ``label`` : A String that holds the label associated with the community.

   This enum include **one** constructor :

   .. dropdown:: ``XXX`` - Initializes the enum constant with its corresponding label
      :icon: gear

      The ``XXX`` constructor **initializes the enum constant** with its
      corresponding community.

      It requires **one** parameter :

      * ``label`` : The label associated with the community, passed as a string.

      It doesn't return anything.