tik_manager4.objects.entity
===========================

.. py:module:: tik_manager4.objects.entity

.. autoapi-nested-parse::

   Core module for Tik Manager Objects.



Attributes
----------

.. autoapisummary::

   tik_manager4.objects.entity.LOG


Classes
-------

.. autoapisummary::

   tik_manager4.objects.entity.Entity


Module Contents
---------------

.. py:class:: Entity(name='', uid=None)

   Base class for all Tik Manager entities.


   .. py:method:: check_permissions(level)

      Check the user permissions for project actions.

      Args:
          level (int): The permission level required for the action.

      Returns:
          int: 1 if the user has permissions, -1 otherwise.



   .. py:method:: copy_path_to_clipboard(file_or_folder_path)

      Copy the path to the clipboard.



   .. py:method:: generate_id()
      :staticmethod:


      Generate a unique id for the entity.



   .. py:method:: get_abs_database_path(*args)

      Return the absolute database path for the entity.

      Args:
          args (str): The path arguments.
              Any values passed here will be appended to the path.



   .. py:method:: get_abs_project_path(*args)

      Return the absolute project path for the entity.

      Args:
          args (str): The path arguments.
              Any values passed here will be appended to the path.



   .. py:method:: get_metadata(parent_task, key=None)

      Convenience method to get the metadata for work and category objects.



   .. py:method:: get_purgatory_database_path(*args)

      Return the purgatory database path for the entity.

      Args:
          args (str): The path arguments.
              Any values passed here will be appended to the path.



   .. py:method:: get_purgatory_project_path(*args)

      Return the purgatory project path for the entity.

      Args:
          args (str): The path arguments.
              Any values passed here will be appended to the path.



   .. py:method:: show_database_folder()

      Open the database path in Windows Explorer(Windows) or Nautilus(Linux).



   .. py:method:: show_project_folder()

      Open the path in Windows Explorer(Windows) or Nautilus(Linux)



   .. py:attribute:: guard


   .. py:property:: id
      Return the unique id of the entity.



   .. py:property:: is_authenticated
      Return the authentication status of the user.



   .. py:property:: name
      Return the name of the entity.



   .. py:attribute:: object_type


   .. py:property:: path
      Return the relative path of the entity.



   .. py:property:: permission_level
      Return the permission level of the user.



.. py:data:: LOG