Class WorkflowEngineProcessRequest

Запрос на обработку процесса WorkflowEngine.

Hierarchy (View Summary)

StorageObject
- WorkflowEngineProcessRequest

Implements

IWorkflowEngineProcessRequest

Constructors

constructor

new WorkflowEngineProcessRequest(
storage?: IStorage,
): WorkflowEngineProcessRequest
Parameters
- storage: IStorage = {}
Returns WorkflowEngineProcessRequest
Overrides StorageObject.constructor
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:12

Properties - Other

`Readonly`cachedMemberChanged

cachedMemberChanged: EventHandler<
{ fieldName: string; newValue: unknown; oldValue: unknown },
>

`Readonly`fieldChanged

fieldChanged: EventHandler<
{ fieldName: string; newValue: unknown; oldValue: unknown },
>

Properties - Static Keys

`Static` `Readonly`cardIdKey

cardIdKey: "CardID" = 'CardID'

`Static` `Readonly`nodeIdsKey

nodeIdsKey: "NodeIDs" = 'NodeIDs'

`Static` `Readonly`nodeInstanceIdsKey

nodeInstanceIdsKey: "NodeInstanceIDs" = 'NodeInstanceIDs'

`Static` `Readonly`processDigestKey

processDigestKey: "ProcessDigest" = 'ProcessDigest'

`Static` `Readonly`processFlagKey

processFlagKey: "ProcessFlag" = 'ProcessFlag'

`Static` `Readonly`processInstanceIdKey

processInstanceIdKey: "ProcessInstanceID" = 'ProcessInstanceID'

`Static` `Readonly`processTemplateIdKey

processTemplateIdKey: "ProcessTemplateID" = 'ProcessTemplateID'

`Static` `Readonly`processTemplateVersionIdKey

processTemplateVersionIdKey: "ProcessTemplateVersionID" = 'ProcessTemplateVersionID'

`Static` `Readonly`signalKey

signalKey: "Signal" = 'Signal'

`Static` `Readonly`signalProcessingModeKey

signalProcessingModeKey: "SignalProcessingMode" = 'SignalProcessingMode'

`Static` `Readonly`syncObjectKey

syncObjectKey: "SyncObject" = 'SyncObject'

Accessors

cachedMembers

get cachedMembers(): ReadonlyMap<string, unknown>
Returns ReadonlyMap<string, unknown>
Inherited from StorageObject.cachedMembers
- Defined in @tessa/core/src/storage/storageObject.ts:90

cardId

get cardId(): null | string
Идентификатор карточки, для которой выполняется обработка процесса. Используется при запуске нового процесса.

Returns null | string
Implementation of IWorkflowEngineProcessRequest.cardId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:119
set cardId(value: null | string): void
Идентификатор карточки, для которой отправляется процесс, или null, если карточка определяется по экземпляру процесса или процесс глобальный.
Parameters
- value: null | string
Returns void
Implementation of IWorkflowEngineProcessRequest.cardId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:122

isObservable

get isObservable(): boolean
Определяет, является ли хранилище наблюдаемым, то есть поддерживает механизм автоматического оповещения о своих изменениях.

Если значение этого свойства равно true, то объект класса может быть подписан на изменения, и соответствующие обработчики будут вызываться при каждом изменении состояния объекта.

В противном случае, если значение false, объект считается ненаблюдаемым, и изменения в его состоянии не будут автоматически передаваться другим частям программы.

Returns boolean
Inherited from StorageObject.isObservable
- Defined in @tessa/core/src/storage/storageObject.ts:83
set isObservable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StorageObject.isObservable
- Defined in @tessa/core/src/storage/storageObject.ts:86

nodeIds

get nodeIds(): TypedStorageArray<Guid>
Список идентификаторов узлов, для которых выполняется обработка сигнала. Используется при отправки сигнала в существующий процесс.

Returns TypedStorageArray<Guid>
Implementation of IWorkflowEngineProcessRequest.nodeIds
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:130
set nodeIds(value: string[]): void
Список идентификаторов узлов, на которые производится отправка сигнала.
Parameters
- value: string[]
Returns void
Implementation of IWorkflowEngineProcessRequest.nodeIds
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:135

nodeInstanceIds

get nodeInstanceIds(): TypedStorageArray<Guid>
Список идентификаторов экземпляров узлов, для которых выполняется обработка сигнала. Используется при отправки сигнала в существующий процесс.

Returns TypedStorageArray<Guid>
Implementation of IWorkflowEngineProcessRequest.nodeInstanceIds
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:146
set nodeInstanceIds(value: string[]): void
Список идентификаторов экземпляров узлов, на которые производится отправка сигнала.
Parameters
- value: string[]
Returns void
Implementation of IWorkflowEngineProcessRequest.nodeInstanceIds
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:151

processDigest

get processDigest(): null | string
Дайджест процесса. Используется при отправки сигнала в существующий процесс.

Returns null | string
Implementation of IWorkflowEngineProcessRequest.processDigest
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:108
set processDigest(value: null | string): void
Наименование процесса или экземпляра процесса, отображаемое в асинхронной операции, или null, если имя определяется автоматически.
Parameters
- value: null | string
Returns void
Implementation of IWorkflowEngineProcessRequest.processDigest
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:111

processFlag

get processFlag(): number
Флаг обработки процесса или null, если используется набор флагов по умолчанию.

Returns number
Implementation of IWorkflowEngineProcessRequest.processFlag
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:173
set processFlag(value: number): void
Флаг для обработки процесса.
Parameters
- value: number
Returns void
Implementation of IWorkflowEngineProcessRequest.processFlag
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:176

processInstanceId

get processInstanceId(): null | string
Идентификатор экземпляра процесса или null, если выполняется запуск процесса.

Returns null | string
Implementation of IWorkflowEngineProcessRequest.processInstanceId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:75
set processInstanceId(value: null | string): void
Идентификатор экземпляра процесса.
Parameters
- value: null | string
Returns void
Implementation of IWorkflowEngineProcessRequest.processInstanceId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:78

processTemplateId

get processTemplateId(): null | string
Идентификатор карточки шаблона процесса. Используется при запуске нового процесса.

Returns null | string
Implementation of IWorkflowEngineProcessRequest.processTemplateId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:86
set processTemplateId(value: null | string): void
Идентификатор шаблона процесса. Необходим при создании нового процесса, если не задан processTemplateVersionId
Parameters
- value: null | string
Returns void
Implementation of IWorkflowEngineProcessRequest.processTemplateId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:89

processTemplateVersionId

get processTemplateVersionId(): null | string
Идентификатор версии шаблона процесса. Используется при запуске нового процесса.

Returns null | string
Implementation of IWorkflowEngineProcessRequest.processTemplateVersionId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:97
set processTemplateVersionId(value: null | string): void
Идентификатор версии шаблона процесса. Необходим при создании нового процесса, если не задан processTemplateId
Parameters
- value: null | string
Returns void
Implementation of IWorkflowEngineProcessRequest.processTemplateVersionId
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:100

signal

get signal(): WorkflowEngineSignal
Обрабатываемый сигнал.

Returns WorkflowEngineSignal
Implementation of IWorkflowEngineProcessRequest.signal
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:159
set signal(value: WorkflowEngineSignal): void
Отправляемый сигнал.
Parameters
- value: WorkflowEngineSignal
Returns void
Implementation of IWorkflowEngineProcessRequest.signal
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:166

signalProcessingMode

get signalProcessingMode(): number
Режим обработки сигнала.

Returns number
Implementation of IWorkflowEngineProcessRequest.signalProcessingMode
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:183
set signalProcessingMode(value: number): void
Флаг определяет метод обработки сигнала.
Parameters
- value: number
Returns void
Implementation of IWorkflowEngineProcessRequest.signalProcessingMode
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:186

syncObject

get syncObject(): null | string
Объект для синхронизации обработки сигнала или null, если синхронизация обработки сигнала не требуется.

Returns null | string
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:193
set syncObject(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:196

Methods

clean

clean(): void
Выполняет очистку хранилища от избыточных данных.

Returns void
Inherited from StorageObject.clean
- Defined in @tessa/core/src/storage/storageObject.ts:494

ensureCacheResolved

ensureCacheResolved(): void
Выполняет резолв кеша декораторов для данных объекта-хранилища.

Returns void
Inherited from StorageObject.ensureCacheResolved
- Defined in @tessa/core/src/storage/storageObject.ts:500

getStorage

getStorage(): IStorage
Возвращает хранилище IStorage, декоратором для которого является текущий объект.

Returns IStorage
Хранилище IStorage, декоратором для которого является текущий объект.
Implementation of IWorkflowEngineProcessRequest.getStorage
Inherited from StorageObject.getStorage
- Defined in @tessa/core/src/storage/storageObject.ts:486

getStorageSettings

getStorageSettings(): Readonly<StorageSettings>
Возвращает настройки объекта-хранилища.

Returns Readonly<StorageSettings>
Inherited from StorageObject.getStorageSettings
- Defined in @tessa/core/src/storage/storageObject.ts:520

notifyStorageUpdated

notifyStorageUpdated(): void
Метод, уведомляющий объект о наличии изменений в его хранилище.

Returns void
Inherited from StorageObject.notifyStorageUpdated
- Defined in @tessa/core/src/storage/storageObject.ts:506

tryGetNodeIds

tryGetNodeIds(): null | TypedStorageArray<Guid, string>
Returns null | TypedStorageArray<Guid, string>
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:208

tryGetNodeInstanceIds

tryGetNodeInstanceIds(): null | TypedStorageArray<Guid, string>
Returns null | TypedStorageArray<Guid, string>
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:214

tryGetSignal

tryGetSignal(): null | IWorkflowEngineSignal
Returns null | IWorkflowEngineSignal
- Defined in @tessa/platform/src/workflow/workflowEngineProcessRequest.ts:204

Class WorkflowEngineProcessRequest

Hierarchy (View Summary)

Implements

Index

Constructors

Properties - Other

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

Returns WorkflowEngineProcessRequest

Properties - Other

ReadonlycachedMemberChanged

ReadonlyfieldChanged

Properties - Static Keys

Static ReadonlycardIdKey

Static ReadonlynodeIdsKey

Static ReadonlynodeInstanceIdsKey

Static ReadonlyprocessDigestKey

Static ReadonlyprocessFlagKey

Static ReadonlyprocessInstanceIdKey

Static ReadonlyprocessTemplateIdKey

Static ReadonlyprocessTemplateVersionIdKey

Static ReadonlysignalKey

Static ReadonlysignalProcessingModeKey

Static ReadonlysyncObjectKey

Accessors

cachedMembers

Returns ReadonlyMap<string, unknown>

cardId

Returns null | string

Parameters

Returns void

isObservable

Returns boolean

Parameters

Returns void

nodeIds

Returns TypedStorageArray<Guid>

Parameters

Returns void

nodeInstanceIds

Returns TypedStorageArray<Guid>

Parameters

Returns void

processDigest

Returns null | string

Parameters

Returns void

processFlag

Returns number

Parameters

Returns void

processInstanceId

Returns null | string

Parameters

Returns void

processTemplateId

Returns null | string

Parameters

Returns void

processTemplateVersionId

Returns null | string

Parameters

Returns void

signal

Returns WorkflowEngineSignal

Parameters

Returns void

signalProcessingMode

Returns number

Parameters

Returns void

syncObject

Returns null | string

Parameters

Returns void

Methods

`Readonly`cachedMemberChanged

`Readonly`fieldChanged

`Static` `Readonly`cardIdKey

`Static` `Readonly`nodeIdsKey

`Static` `Readonly`nodeInstanceIdsKey

`Static` `Readonly`processDigestKey

`Static` `Readonly`processFlagKey

`Static` `Readonly`processInstanceIdKey

`Static` `Readonly`processTemplateIdKey

`Static` `Readonly`processTemplateVersionIdKey

`Static` `Readonly`signalKey

`Static` `Readonly`signalProcessingModeKey

`Static` `Readonly`syncObjectKey