Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.
Информация
iconfalse

Интерфейс представляет собой Приложение (application) для работы с произвольным

НР-

настраиваемым объектом

.

Примечание
iconfalse

ru.intertrust.cmj.tunable.object.TunableObjectApplication

Подсказка
iconfalse
extends: AFApplication.
CanGetEntityByUNID<AnyTunableObject> methods
CanGetEntityByUNID<AnyTunableObject>, AFApplication.CanGetComplects

properties

property

namereturn valuedescription

composeApplicationTunableObject

AnyTunableObject

Метод создает прикладной объект с типом объекта TUNABLE_OBJECT.
Для успешного выполнения требуется наличие соот. настройки "Тип документа" в БД Каталог.

Параметры:

  • schema- Schema - схема объекта
  • module- String - тип БД объекта
  • complect- String - комплект БД объекта
  • replica- String - реплика БД объекта, задается для объектов другой СО или БД другого комплекта

    getClientContextIds

    List<String>

    Если контекст - коллекция, то  возвращает ids выделенных галкой документов из коллекции, если выделенных галкой нет, то id сфокусированного.
    Если контекст - документ, то  возвращает id документа.

    Параметры:

    • paramsTuning - AnyTunableObject - ресурс со свойством $clientContext

    getClientContextResourceId

    String

    Метод возвращает id контекстного документа. Из коллекции- id выделенного фокусом документа, из открытого документа - id документа.

    Параметры:

    • paramsTuning - AnyTunableObject - ресурс со свойством $clientContext

    getClientContextFocusedId

    String

    Метод возвращает id  выделенного фокусом документа из коллекции.

    Параметры:

    • paramsTuning - AnyTunableObject - ресурс со свойством $clientContext

    contextIsCollection

    Boolean

    Метод возвращает признак того, что операция вызвана из коллекции.

    Параметры:

    • paramsTuning - AnyTunableObject - ресурс со свойством $clientContext

    getClientContextActionRel

    String

    Метод возвращает id действия.

    Параметры:

    • paramsTuning - AnyTunableObject - ресурс со свойством $clientContext

    getClientContextResource

    AFInstanceObject

    Метод возвращает НР-карту ресурса из клиентского контекста.

    Параметры:

    • anyAFInstanceObject - AFInstanceObject - НР-карта ресурса со свойством $clientContext

    getClientContextLockerSign

    AFInstanceObject

    Метод возвращает НР-карту сформированной ЭП из клиентского контекста.

    Параметры:

    • anyAFInstanceObject - AFInstanceObject - НР-карта ресурса со свойством $clientContext

    getEntityByUNIDSpecial

    AnyTunableObject

    Особое получение сущности

    Параметры:

    • entityUnid - String - TN-UNID сущности

    getEmbeddedCollectionSubObjects

    List<AnyTunableObject>

    Получение вложенной коллекции в документе

    Параметры:

    • parentUnid - String - unid родительского документа
    • type - String - тип коллекции, однозначно идентифицирует коллекцию внтури корневого документа

    methods

    namereturn valuedescription

    composeApplicationTunableObject

    AnyTunableObject

    Метод создает прикладной объект с типом объекта TUNABLE_OBJECT.


    Для успешного выполнения требуется наличие соот. настройки "

    Тип документа" в БД Каталог.

    Документа"

    Параметры:

    • schema - Schema - схема объекта
    • module - String - тип БД объекта
    • complect - String - комплект БД объекта
    • replica - String - реплика БД объекта, задается для объектов другой СО или БД другого комплекта
    • param - ComposeApplicationTunableObjectParams.IfAFApplicationObjectTypeNotExist - если ERROR, то в случае отсутствия
      настройки "
    Тип документа в БД Каталог
    • возникает ошибка, если CREATE - то создается памяти соответствующий типу объект ApplicationObjectType 

    composeTunableObject

    AnyTunableObject

    Метод получает объект с заданной схемой

    .

    Параметры:

    • schema - Schema - схема объекта
    • module - String - тип БД объекта
    • complect - String - комплект БД объекта
    • replica - String - реплика БД объекта, задается для объектов другой СО или БД другого комплекта

    composeTunableObject

    AnyTunableObject

    Метод получает объект с заданной схемой

    .

    Параметры:

    • schema - Schema - схема объекта

    composeDialog

    AnyTunableObject

    Метод получает объект-пустышку для диалога.

    Параметры:

    • schema - Schema - схема объекта
    • module - String - тип БД объекта
    • complect - String - комплект БД объекта
    • replica - String - реплика БД объекта, задается для объектов другой СО или БД другого комплекта

    requestForSimpleDraft

    Object

    Метод возвращает один из ресурсов: черновик, ресурс диалога, запрос на клиентский контекст.

    Параметры:

    • schema -
    Schema
    • String - схема объекта
    • strategyKey - String - ключ стратегии StrategyCreateDraft. Если не указан, то в качестве ключа используется имя схемы
    • ident- String - тип БД объекта
    • complect - String - комплект БД объекта
    • replica - String - реплика БД объекта, задается для объектов другой СО или БД другого комплекта
    • params - AnyTunableObject - параметры операции (ресурс диалога, выбранные документы)

    requestForChildDraft

    AnyTunableObject

    Метод возвращает один из ресурсов: черновик для дочернего объекта, ресурс диалога

    Параметры:

    • schema - Schema - схема объекта
    • strategyKey - String - ключ стратегии StrategyCreateDraft. Если не указан, то в качестве ключа используется имя схемы
    • params - AnyTunableObject - параметры операции (ресурс диалога, выбранные документы) .
      params должен содержать свойство $clientContext.data.resourceid (с тем же типом что и в схеме ClientContextRequest)  с tnUnid контекстного НР-объекта

    requestForSiblingDraft

    AnyTunableObject

    Метод возвращает один из ресурсов: черновик для одноуровневого (относительно контекстного объекта) объекта , ресурс диалога

    Параметры:

    • schema - Schema - схема объекта
    • strategyKey - String - ключ стратегии StrategyCreateDraft. Если не указан, то в качестве ключа используется имя схемы
    • params - AnyTunableObject - параметры операции (ресурс диалога, выбранные документы) .
      params должен содержать свойство $clientContext.data.resourceid (с тем же типом что и в схеме ClientContextRequest)  с tnUnid контекстного НР-объекта

    requestForSiblingDraft (tnUnid)

    AnyTunableObject

    Метод возвращает один из ресурсов: черновик для одноуровневого (относительно контекстного объекта) объекта , ресурс диалога

    Параметры:

    • schema - Schema - схема объекта
    • tnUnid - String - tnUnid контекстного НР-объекта

    requestForCopyDraft

    AnyTunableObject

    Метод возвращает один из ресурсов: черновик для копии контекстного объекта, ресурс диалога

    Параметры:

    • schema - Schema - схема объекта
    • params - AnyTunableObject - параметры операции (ресурс диалога, выбранные документы) .
      params должен содержать свойство $clientContext.data.resourceid (с тем же типом что и в схеме ClientContextRequest)  с tnUnid контекстного НР-объекта

    saveEntity


    Сохранение сущности

    Параметры:

    saveEntitySpecial


    Особое

    сохранение

    сущности

    Параметры:

    createClientContextRequest

    AnyTunableObject

    Метод создает объект со схемой ClientContextRequest, по которой клиент должен вернуть клиентский контекст. В клиентский контекст могут входить ids выделенных документов в коллекции, ресурс диалога.

    Параметры:

    • keys
    • -
    ClientContextKey... -setParentIfChild
    • ClientContextKey - список видов данных из клиентского контекста

    deleteEmbeddedCollectionSubObjectsOverdue

    Integer 

    Удаление подобъектов без родителя созданных до определенного времени

    Параметры:

    • cutOff - Date - ограничение на время удаления

    deletePermanently (tunableObject)


    Удаляет сущность из хранилища без возможности восстановления.

    Параметры:

    conextDocTnUnid - String  
    •  - удаляемая сущность

    deletePermanently (id)


    Удаляет сущность из хранилища без возможности восстановления по идентификатору

    Параметры:

    id - String - unid документа

    enum <ClientContextKey>

    Виды данных из клиентского контекста

    name

    description

    compactCollection

    ids выделенных галкой документов в коллекции

    resource

    Ресурс (используется для передачи от клиента серверу контекстного ресурса)

    resourceid

    Id ресурса. Если операция вызывается в контексте коллекции, то клиент передает id элемента, выделенного в коллекции путем установки фокуса. Если операция вызывается из открытого документа, то клиент передает id этого документа, значение которого клиент берет из поля $id ресурса.

    mainresourceid

    Актуально для случая, когда из меню внешней коллекции, встроенной в форму открытого объекта, по кнопке нужно получить id открытого документа.

    actionRel

    Идентификатор действия

    resourcemode

    Режим

    lockerSign

    Запрос формирования ЭП для текущего контекстного объекта. Необходимые данные клиент берёт из ClientContext/serverData/lockerSign, сформированную ЭП кладёт в ClientContext/data/lockerSign
    Свойства страницы
    Статус

    Статус
    colour

    Blue

    Green
    title

    ДОработка

    ГОТОВО

    Комментарий
    панель

    Методы, свойства, внутренние классы

    Оглавление