tik_manager4.objects.guard

Module to communicate with other modules regarding the application state.

Classes

Guard

Global object that holds the state of the application.

Module Contents

class Guard

Global object that holds the state of the application.

classmethod set_authentication_status(state)

Set the authentication status of the user.

Args:

state (bool): The authentication status.

classmethod set_category_definitions(definitions)

Set the category definitions.

Args:

definitions (Settings): The category definitions.

classmethod set_commons(commons)

Set the commons object.

Args:

commons (Commons): The commons object.

classmethod set_database_root(root)

Set the database root path.

Args:

root (str): The database root path.

classmethod set_dcc(dcc_name)

Set the DCC name.

Args:

dcc_name (str): The name of the DCC.

classmethod set_dcc_handler(handler)

Set the DCC handler object.

Args:

handler (object): The DCC handler object.

classmethod set_localize_settings(localize_settings)

Set the localize settings object.

Args:

localize_settings (Settings): The localize settings object.

classmethod set_management_handler(handler)

Set the management handler object.

Args:

handler (object): The management handler object.

classmethod set_metadata_definitions(definitions)

Set the metadata definitions.

Args:

definitions (Settings): The metadata definitions.

classmethod set_permission_level(level)

Set the permission level for the current user.

classmethod set_preview_settings(preview_settings)

Set the preview settings object.

Args:

preview_settings (Settings): The preview settings object.

classmethod set_project_root(root)

Set the project root path.

Args:

root (str): The project root path.

classmethod set_project_settings(project_settings)

Set the project settings object.

Args:

project_settings (Settings): The project settings object.

classmethod set_user(user)

Set the user name.

Args:

user (User): The user object.

property category_definitions

Return the category definitions.

commons = None

property database_root

Return the database root path.

property dcc

Return the DCC name.

property dcc_handler

Return the DCC handler object.

property email

Return the email of the user.

property is_authenticated

Return the authentication status of the user.

localize_settings = None

property management_handler

Return the management handler object.

property metadata_definitions

Return the metadata definitions.

property permission_level

Return the permission level of the user.

preview_settings = None

property project_root

Return the project root path.

project_settings = None

property user

Return the user name.