Общая информация о задании, которое выдано на карточку.

Hierarchy

Implements

Constructors

Properties - Other

Properties - Static Keys

Accessors

Methods

Constructors

  • Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.

    Parameters

    • storage: IStorage<unknown> = {}

      Хранилище, декоратором для которого является создаваемый объект.

    Returns CardTask

Other Properties

canPostponeExplicit: null | boolean = null

Признак того, что для задания требуется принудительно установить возможность откладывания canPostpone.

Remarks

Это свойство не записывается в хранилище, поэтому оно эффективно только для текущего декоратора.

isHidden: boolean = false

Признак того, что задание не следует показывать в UI несмотря на то, что оно присутствует в карточке.

Remarks

Это свойство не записывается в хранилище, поэтому оно эффективно только для текущего декоратора.

isLockedExplicit: null | boolean = null

Признак того, что для задания требуется принудительно установить режим просмотра isLocked.

Remarks

Это свойство не записывается в хранилище, поэтому оно эффективно только для текущего декоратора.

Событие, возникающее при изменении состояния файла state.

Static Keys Properties

actionKey: "Action" = 'Action'
authorIdKey: "AuthorID" = 'AuthorID'
authorNameKey: "AuthorName" = 'AuthorName'
calendarIdKey: "CalendarID" = 'CalendarID'
calendarNameKey: "CalendarName" = 'CalendarName'
cardKey: "Card" = 'Card'
digestKey: "Digest" = 'Digest'
formattedPlannedKey: "FormattedPlanned" = 'FormattedPlanned'
groupRowIdKey: "GroupRowID" = 'GroupRowID'
historyItemParentRowIdKey: "HistoryItemParentRowID" = 'HistoryItemParentRowID'
historySettingsKey: "HistorySettingsKey" = 'HistorySettingsKey'
inProgressKey: "InProgress" = 'InProgress'
infoKey: "Info" = 'Info'
optionIdKey: "OptionID" = 'OptionID'
parentRowIdKey: "ParentRowID" = 'ParentRowID'
plannedKey: "Planned" = 'Planned'
plannedQuantsKey: "PlannedQuants" = 'PlannedQuants'
plannedTypeKey: "PlannedType" = 'PlannedType'
plannedWorkingDaysKey: "PlannedWorkingDays" = 'PlannedWorkingDays'
postponeCommentKey: "PostponeComment" = 'PostponeComment'
postponedKey: "Postponed" = 'Postponed'
postponedToKey: "PostponedTo" = 'PostponedTo'
processIdKey: "ProcessID" = 'ProcessID'
processKindKey: "ProcessKind" = 'ProcessKind'
processNameKey: "ProcessName" = 'ProcessName'
resultKey: "Result" = 'Result'
rowIdKey: "RowID" = 'RowID'
sectionRowsKey: "SectionRows" = 'SectionRows'
settingsKey: "Settings" = 'Settings'
systemFlagsKey: string = ...
systemStateKey: string = ...
systemStoredStateKey: string = ...
taskAssignedRolesKey: "TaskAssignedRoles" = 'TaskAssignedRoles'
taskSessionRolesKey: "TaskSessionRoles" = 'TaskSessionRoles'
timeZoneIdKey: "TimeZoneID" = 'TimeZoneID'
timeZoneUtcOffsetMinutesKey: "TimeZoneUtcOffsetMinutes" = 'TimeZoneUtcOffsetMinutes'
typeCaptionKey: "TypeCaption" = 'TypeCaption'
typeIdKey: "TypeID" = 'TypeID'
typeNameKey: "TypeName" = 'TypeName'
userIdKey: "UserID" = 'UserID'
userNameKey: "UserName" = 'UserName'

Accessors

  • get action(): number
  • Действие, выполняемое для задания.

    Returns number

  • set action(value: number): void
  • Parameters

    • value: number

    Returns void

  • get authorId(): null | string
  • Идентификатор пользователя, который определён как Автор. По умолчанию при сохранении наполняется (если не был заполнен), как первый по GUID сотрудник из всех, кто входит в taskAssignedRoles с ФР CardFunctionRoles.authorId, если нет ни одного "Автора", то текущая сессия. По умолчанию значение равно null.

    Returns null | string

  • set authorId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get authorName(): null | string
  • Имя пользователя, который определён как Автор. По умолчанию при сохранении наполняется (если не был заполнен), как первый по GUID сотрудник из всех, кто входит в taskAssignedRoles с ФР CardFunctionRoles.authorId, если нет ни одного "Автора", то текущая сессия. По умолчанию значение равно null.

    Returns null | string

  • set authorName(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get calendarId(): null | string
  • ID календаря.

    Returns null | string

  • set calendarId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get calendarName(): null | string
  • Название календаря.

    Returns null | string

  • set calendarName(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get canPostpone(): boolean
  • Получает или задаёт признак того, что задание может быть отложено. Этот флаг не влияет на сохранение задания.

    Returns boolean

  • set canPostpone(value: boolean): void
  • Parameters

    • value: boolean

    Returns void

  • get canPostponeEffective(): boolean
  • Возможность откладывания задания canPostpone, полученная с учётом признака canPostponeExplicit.

    Returns boolean

  • get card(): Card
  • Карточка задания.

    Returns Card

  • set card(value: Card): void
  • Parameters

    Returns void

  • get digest(): null | string
  • Digest задания, или null, если задание ещё не создано или Digest задания не указан. Digest содержит произвольный текст, описывающий задание и выводимый пользователям. Значение нельзя изменить после того, как задание было создано.

    Returns null | string

  • set digest(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get flags(): number
  • Флаги задания.

    Returns number

  • set flags(value: number): void
  • Parameters

    • value: number

    Returns void

  • get formattedPlanned(): null | string
  • Отформатированная строка со сроком исполнения задания.

    Returns null | string

  • set formattedPlanned(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get groupRowId(): string
  • Идентификатор группы истории заданий.

    Returns string

  • set groupRowId(value: string): void
  • Parameters

    • value: string

    Returns void

  • get historyItemParentRowId(): null | string
  • Ссылка на родительскую запись в истории заданий, которая учитывается только при автоматическом создании записи в истории заданий в процессе сохранения карточки. При создании и загрузке карточки поле не заполняется и равно null.

    Returns null | string

  • set historyItemParentRowId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get historySettings(): null | IStorage<unknown>
  • Настройки записи истории задания, сериализуемые в JSON, которые учитывается только при автоматическом создании записи в истории заданий в процессе сохранения задания. При создании и загрузке задания поле не заполняется и равно null.

    Returns null | IStorage<unknown>

  • set historySettings(value: null | IStorage<unknown>): void
  • Parameters

    Returns void

  • get inProgress(): null | string
  • Дата взятия задания в работу или null, если задание ещё не было взято в работу.

    Returns null | string

  • set inProgress(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get info(): IStorage<unknown>
  • Дополнительная пользовательская информация.

    Returns IStorage<unknown>

  • set info(value: IStorage<unknown>): void
  • Parameters

    Returns void

  • get isCanPerform(): boolean
  • Пользователь может видеть задание с вариантами завершения. Либо он входит в роль из списка taskAssignedRoles как пользователь или заместитель; либо он взял задание в работу, даже если уже не входит в роль; либо он является заместителем пользователя, взявшего задание в работу, в роли из списка taskAssignedRoles.

    Returns boolean

  • get isCanPerformAsDeputy(): boolean
  • Пользователь видит задание с вариантами завершения, т.к. является заместителем. Либо он входит в роль из списка taskAssignedRoles как заместитель; Либо он является заместителем пользователя, взявшего задание в работу, в роли из списка taskAssignedRoles.

    Returns boolean

  • get isLocked(): boolean
  • Задание не содержит загруженных данных и доступно только для просмотра общей информации.

    Returns boolean

  • get isLockedEffective(): boolean
  • Режим просмотра isLocked, полученный с учётом признака isLockedExplicit.

    Returns boolean

  • get isPostponed(): boolean
  • Задание отложено. Флаг устанавливается при загрузке и не влияет на сохранение.

    Returns boolean

  • get isSystem(): boolean
  • Пользователь видит задание как системный пользователь с особыми привилегиями.

    Returns boolean

  • get optionId(): null | string
  • Идентификатор варианта завершения задания, или null, если для задания ещё не был определён вариант завершения.

    Returns null | string

  • set optionId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get parentRowId(): null | string
  • Ссылка на родительское задание.

    Returns null | string

  • set parentRowId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get planned(): null | string
  • Дата запланированного завершения задания или null, если задание ещё не было создано.

    Returns null | string

  • set planned(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get plannedQuants(): null | number
  • Количество квантов календаря от времени на момент загрузки задания до времени его запланированного завершения planned или null, если задание ещё не было создано.

    Returns null | number

  • set plannedQuants(value: null | number): void
  • Parameters

    • value: null | number

    Returns void

  • get plannedType(): CardTaskPlannedType
  • Тип запланированного времени. В зависимости от указанного - трактует planned, как время исполнителя или автора.

    Returns CardTaskPlannedType

  • set plannedType(value: CardTaskPlannedType): void
  • Parameters

    Returns void

  • get plannedWorkingDays(): null | number
  • Количество рабочих дней по календарю от времени на момент загрузки задания до времени его запланированного завершения planned или null, если задание ещё не было создано. Если возвращаемое рабочих дней отрицательное, то задание просрочено.

    Returns null | number

  • set plannedWorkingDays(value: null | number): void
  • Parameters

    • value: null | number

    Returns void

  • get postponeComment(): null | string
  • Комментарий по откладыванию задания или null, если задание не было отложено или пользователь не задал комментария.

    Поле устанавливается пользователем при откладывании задания.

    Returns null | string

  • set postponeComment(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get postponed(): null | string
  • Дата и время, когда было отложено задание, или null, если задание не было отложено.

    Поле устанавливается системой при откладывании задания.

    Returns null | string

  • set postponed(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get postponedTo(): null | string
  • Дата и время, до которого было отложено задание, или null, если задание не было отложено.

    Поле устанавливается пользователем при откладывании задания.

    Returns null | string

  • set postponedTo(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get processId(): null | string
  • Идентификатор бизнес-процесса, к которому относится запись в истории заданий, которая будет добавлена для задания, или null, если запись не относится к бизнес-процессу.

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

    По умолчанию значение равно null.

    Returns null | string

  • set processId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get processKind(): null | string
  • Тип бизнес-процесса, к которому относится запись в истории заданий, которая будет добавлена для задания, или null, если запись не относится к бизнес-процессу или не содержит информации по его типу.

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

    По умолчанию значение равно null.

    Returns null | string

  • set processKind(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get processName(): null | string
  • Отображаемое имя бизнес-процесса, к которому относится запись в истории заданий, которая будет добавлена для задания, или null, если запись не относится к бизнес-процессу.

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

    По умолчанию значение равно null.

    Returns null | string

  • set processName(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get result(): null | string
  • Результат завершения задания, или null, если либо задание не завершается, либо результат устанавливается серверными расширениями или не устанавливается вообще.

    Результат может быть установлен не только при завершении задания, но и при создании записи в истории заданий посредством указания флага CreateHistoryItem.

    Returns null | string

  • set result(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get rowId(): string
  • Идентификатор задания.

    Returns string

  • set rowId(value: string): void
  • Parameters

    • value: string

    Returns void

  • get sectionRows(): StorageMap<CardRow, IStorage<unknown>>
  • Пустые строки коллекционных и древовидных секций, доступные по имени секции. Могут использоваться для редактирования карточки задания.

    Returns StorageMap<CardRow, IStorage<unknown>>

  • set sectionRows(value: StorageMap<CardRow, IStorage<unknown>>): void
  • Parameters

    Returns void

  • get settings(): null | IStorage<unknown>
  • Настройки задания.

    Returns null | IStorage<unknown>

  • set settings(value: null | IStorage<unknown>): void
  • Parameters

    Returns void

  • get state(): CardRowState
  • Состояние строки с заданием.

    Returns CardRowState

  • set state(value: CardRowState): void
  • Parameters

    Returns void

  • get storedState(): CardTaskState
  • Начальное состояние задания при загрузке или Created, если задание создаётся в первый раз.

    Returns CardTaskState

  • set storedState(value: CardTaskState): void
  • Parameters

    Returns void

  • get timeZoneId(): null | number
  • Идентификатор временной зоны задания.

    Returns null | number

  • set timeZoneId(value: null | number): void
  • Parameters

    • value: null | number

    Returns void

  • get timeZoneUtcOffsetMinutes(): null | number
  • Смещение временной зоны задания.

    Returns null | number

  • set timeZoneUtcOffsetMinutes(value: null | number): void
  • Parameters

    • value: null | number

    Returns void

  • get typeCaption(): string
  • Отображаемое имя типа задания.

    Returns string

  • set typeCaption(value: string): void
  • Parameters

    • value: string

    Returns void

  • get typeId(): string
  • Идентификатор типа задания.

    Returns string

  • set typeId(value: string): void
  • Parameters

    • value: string

    Returns void

  • get typeName(): string
  • Имя типа задания.

    Returns string

  • set typeName(value: string): void
  • Parameters

    • value: string

    Returns void

  • get userId(): null | string
  • Идентификатор пользователя, который взял задание в работу, или null, если задание ещё не было взято в работу.

    Returns null | string

  • set userId(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

  • get userName(): null | string
  • Имя пользователя, который взял задание в работу, или null, если задание ещё не было взято в работу.

    Returns null | string

  • set userName(value: null | string): void
  • Parameters

    • value: null | string

    Returns void

Methods

  • Метод для простого добавления исполнителя в задание.

    Returns

    Созданная функциональная роль автора задания.

    Parameters

    • authorId: string

      Идентификатор роли автора задания.

    • Optional authorName: null | string

      Имя роли автора задания. Если не задано, система определяет его автоматически.

    • Optional authorPosition: null | string

      Должность автора задания. Если не задано, система определяет должность автоматически.

    Returns CardTaskAssignedRole

  • Метод для простого добавления исполнителя в задание.

    Returns

    Созданная функциональная роль исполнителя задания.

    Parameters

    • roleId: string

      Идентификатор роли исполнителя.

    • Optional roleName: null | string

      Имя роли исполнителя. Если не задано, система определяет его автоматически.

    • Optional master: boolean

      Определяет, является ли данная роль главной среди всех исполнителей и других функциональных ролей задания.

    Returns CardTaskAssignedRole

  • Добавление роли в список ролей связанных с заданием.

    Returns

    Запись о функциональной роли в задании.

    Parameters

    • roleId: string

      ID роли, которая будет добавлена.

    • roleName: string

      Имя роли, которая будет добавлена.

    • functionRoleId: string

      ID функциональной роли для добавляемой записи.

    • Optional parentRowId: null | string

      RowId родительской записи.

    • Optional showInTaskDetails: null | boolean

      Отображать ли запись в списке ролей балона задания

    • Optional master: boolean

      Признак того, что эта запись является основной. На её основе будет определяться временная зона, календарь и т.д.

    Returns CardTaskAssignedRole

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

  • Очищает все флаги flags, влияющие на смену состояния, а также все сохраняемые данные в карточке card.

    Returns void

  • Создает новый объект, который является копией текущего экземпляра.

    Returns CardTask

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

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

    Returns

    Хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage<unknown>

  • Возвращает признак того, что карточка задания содержит изменённые значения.

    Returns

    true, если карточка задания содержит изменённые значения; false в противном случае.

    Parameters

    • checkStates: boolean = true

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

    Returns boolean

  • Возвращает признак того, что во флагах flags установлены флаги, влияющие на смену состояния на изменённое.

    Returns

    true, если во флагах flags установлены флаги, влияющие на смену состояния на изменённое; false в противном случае.

    Returns boolean

  • Возвращает признак того, что объект не содержит значимых данных для метода очистки.

    Returns

    true, если объект не содержит значимых для метода очистки данных; false в противном случае.

    Returns boolean

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

    Returns

    true, если объект прошёл проверку на валидность; false в противном случае.

    Returns boolean

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

    Returns void

  • Выполняет удаление информации по состояниям, из которой можно было бы определить, что задание изменено. Возвращает признак того, что при этом были внесены изменения.

    Returns

    true, если в процессе удаления были внесены изменения; false в противном случае.

    Parameters

    • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

      Способ обработки удалённых строк, файлов и заданий.

    Returns boolean

  • Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.systemKeyPrefix.

    Returns void

  • Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.userKeyPrefix.

    Returns void

  • Связывает данные текущего объекта с заданной карточкой задания.

    При это устанавливаются свойства rowId, typeId, typeName, typeCaption и card.

    Parameters

    • card: Card

      Карточка задания, с которой связывается текущий объект.

    Returns void

  • Возвращает карточку задания или null, если карточка ещё не была задана.

    Returns

    Карточка задания или null, если карточка ещё не была задана.

    Returns null | Card

  • Returns null | IStorage<unknown>

  • Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана.

    Returns

    Дополнительная пользовательская информацию по текущему объекту или null, если информация ещё не была задана.

    Returns null | IStorage<unknown>

  • Возвращает карточку для сохранения задания или null, если карточка ещё не была задана.

    В отличие от метода tryGetCard, этот метод может создать копию основной карточки и удалить из неё все поля, кроме изменяемых, если выполняется завершение задания без удаления, т.е. свойство state равно Modified, а свойство action равно Complete.

    Returns

    Карточка для сохранения задания или null, если карточка ещё не была задана.

    Parameters

    • storeMethod: CardStoreMethod = CardStoreMethod.Default

      Метод сохранения карточки.

    Returns null | Card

  • Возвращает пустые строки для коллекционных и древовидных секций, доступные по имени секции, или null, если строки ещё не были заданы.

    Returns

    Пустые строки для коллекционных и древовидных секций, доступные по имени секции, или null, если строки ещё не были заданы.

    Returns null | StorageMap<CardRow, IStorage<unknown>>

  • Returns null | IStorage<unknown>

  • Возвращает список записей функциональных ролей, которые связаны с CardTask. или null, если список ещё не был задан.

    Returns

    Список записей функциональных ролей, которые связаны с CardTask. или null, если список ещё не был задан.

    Returns null | StorageArray<CardTaskAssignedRole>

  • Возвращает список функциональных ролей, которые характерны для текущей сессии.

    Returns

    Список функциональных ролей, которые характерны для текущей сессии.

    Returns null | StorageArray<CardTaskSessionRole>

  • Обновляет состояние задания state и действие с заданием action в зависимости от наличия изменений во флагах или в данных карточки задания.

    Returns

    true, если состояние задания было изменено; false, если состояние задания не требуется изменять, т.к. изменения уже зафиксированы или отсутствуют.

    Returns boolean

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

    Объект, выполняющий построение результата валидации.

    Returns ValidationResult

Generated using TypeDoc