История страницы

composeApplicationTunableObject

AnyTunableObject

composeApplicationTunableObject

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

Параметры:

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

composeTunableObject

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

Параметры:

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

composeTunableObject

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

Параметры:

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

composeDialog

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

Параметры:

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

requestForSimpleDraft

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

Параметры:

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

requestForChildDraft

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

Параметры:

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

requestForSiblingDraft

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

Параметры:

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

requestForSiblingDraft

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

Параметры:

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

requestForCopyDraft

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

Параметры:

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

saveEntity

Сохранение сущности
Параметры:

• tunableObject - AnyTunableObject - сохраняемая сущность

saveEntitySpecial

Особое сохранение сущности

Параметры:

• tunableObject - AnyTunableObject - сохраняемая сущность

createClientContextRequest

AnyTunableObject

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

Параметры:

• keys - ClientContextKey... -

setParentIfChild

Параметры:

• tunableObject - AnyTunableObject
• conextDocTnUnid - String  
  

getClientContextIds

List<String>

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

Параметры:

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

getClientContextResourceId

String

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

Параметры:

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

getClientContextFocusedId

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

Параметры:

• AFInstanceObject - paramsTuning - ресурс со свойством $clientContex

contextIsCollection

boolean

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

Параметры:

• AFInstanceObject - paramsTuning - ресурс со свойством $clientContex

getClientContextActionRel

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

Параметры:

• AFInstanceObject - paramsTuning - ресурс со свойством $clientContex

getClientContextResource

AFInstanceObject

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

Параметры:

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

getClientContextLockerSign

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

Параметры:

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

getEntityByUNIDSpecial

AnyTunableObject

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

Параметры:

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

getEmbeddedCollectionSubObjects

List<AnyTunableObject>

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

Параметры:

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

deleteEmbeddedCollectionSubObjectsOverdue

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

Параметры:

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

deletePermanently

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

AnyTunableObject - tunableObject - удаляемая сущность

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

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

compactCollection

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

resource

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

resourceid

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

mainresourceid

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

actionRel

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

resourcemode

Режим

lockerSign

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