TbtkScriptMetaCacheObject
`````````````````````````

.. pas:class:: TbtkScriptMetaCacheObject

  Доменный объект для методов и свойств работы и настройки с кешем
  метаданных

  .. pas:attribute:: Active: Boolean

    Флаг включает/отключает использование КЭШа под метаданные.

    :rtype: Boolean


  .. pas:attribute:: CheckVersionInterval: Integer

    Если база поддерживает проверку версии метаданных при загрузке кеша, то
    есть возможность установить временной период в течение которого версия
    не будет перепроверяться, "доверительный промежуток". Задаётся в
    миллисекундах. По умолчанию свойство выставлено в две минуты
    (120000ms).

    :rtype: Integer

    .. warning:: |not_implemented|


  .. pas:attribute:: CheckVersionActive: Boolean

    Свойство сообщает выполняется ли в данном сеансе проверка версии
    метаданных при загрузке кеша. Значение зависит от: Включен режим
    загрузки метаданных архивом и База данных поддерживает работу с версиями
    метаданных (первый же неотработавший запрос версии выставляет внутренний
    флаг "Версионность метаданных не поддерживается", флаг будет активен до
    самого завершения работы приложения).

    Проверка версии метаданных даёт возможность
    поддерживать кеш метаданных в актуальном состоянии. Для каждой выборки и
    её отображений, а также настроек администрирования на сервере хранится
    версия (метаданных). В результате появляется возможность не
    перезагружать все настройки в слепую и не пользоваться
    вероятно-устаревшими данными из кеша, а просто отправить перед
    необходимой загрузкой запрос версии и осуществлять загрузку только в том
    случае если версия актуальных данных не соответствует версии имеющихся.

    Атрибут только для чтения

    :rtype: Boolean

    .. warning:: |not_implemented|


  .. pas:attribute:: ArchiveMode: Boolean

    Флаг управляет способом загрузки метаданных с сервера. Если значение
    установлено **True**, то загрузка будет выполняться одним запросом архива.
    Если значение **False** (Устаревший режим), то загрузка будет осуществляться
    запросом на каждый тип сущностей. По умолчанию значение **True**.

    :rtype: Boolean

    .. warning:: |not_implemented|


  .. pas:method:: SaveCachedSelectionList()

    Сохранение во временном каталоге пользователя списка выборок, кеш
    метаданных которых присутствует в дисковом кеше метаданных.

    Сохраняется в файл с названием в виде имени сервера к которому
    подключено приложение. Сохраняется в каталоге
    ``%ВременнаяПапкаПользователя%\GlobalSystem\MetaDataCache\``

    .. warning:: |not_implemented|


  .. pas:method:: LoadCachedSelectionList()

    Загружает метаданные с сервера по списку выборок сформированному с
    помощью метода :pas:class:`TbtkScriptMetaCacheObject.SaveCachedSelectionList` и сохраняет в дисковом кеше.

    .. warning:: |not_implemented|


  .. pas:method:: ClearBySelection(EntityName: String)

    Удаляет метаданные выборки с системным именем *EntityName* из кэша
    приложения (*ИмяВыборки.Отображение*).

    .. attention::

      Если передать пустое значение EntityName, то кэш метаданных очищается полностью.

    :param String EntityName:
      Имя выборки.


  .. pas:method:: RecheckMetaVersion()

    Метод сбрасывает счётчики актуальности версии метаданных кеша для всех
    выборок, что приведёт для каждой из выборок к проверке версии метаданных
    перед первой же затребованной загрузкой.

    .. warning:: |not_implemented|