Class CardTask

constructor

• new CardTask(storage?: IStorage): CardTask

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

  Parameters

  • storage: IStorage = {}

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

  Returns CardTask

canPostponeExplicit

isHidden

isLockedExplicit

ReadonlystateChanged

Static ReadonlyactionKey

Static ReadonlyauthorIdKey

Static ReadonlyauthorNameKey

Static ReadonlycalendarIdKey

Static ReadonlycalendarNameKey

Static ReadonlycardKey

Static ReadonlydigestKey

Static ReadonlyformattedPlannedKey

Static ReadonlygroupRowIdKey

Static ReadonlyhistoryItemParentRowIdKey

Static ReadonlyhistorySettingsKey

Static ReadonlyinProgressKey

Static ReadonlyoptionIdKey

Static ReadonlyparentRowIdKey

Static ReadonlyplannedKey

Static ReadonlyplannedQuantsKey

Static ReadonlyplannedTypeKey

Static ReadonlyplannedWorkingDaysKey

Static ReadonlypostponeCommentKey

Static ReadonlypostponedKey

Static ReadonlypostponedToKey

Static ReadonlyprocessIdKey

Static ReadonlyprocessKindKey

Static ReadonlyprocessNameKey

Static ReadonlyresultKey

Static ReadonlyrowIdKey

Static ReadonlysectionRowsKey

Static ReadonlysettingsKey

Static ReadonlysystemFlagsKey

Static ReadonlysystemStateKey

Static ReadonlysystemStoredStateKey

Static ReadonlytaskAssignedRolesKey

Static ReadonlytaskSessionRolesKey

Static ReadonlytimeZoneIdKey

Static ReadonlytimeZoneUtcOffsetMinutesKey

Static ReadonlytypeCaptionKey

Static ReadonlytypeIdKey

Static ReadonlytypeNameKey

Static ReadonlyuserIdKey

Static ReadonlyuserNameKey

action

• get action(): number

  Действие, выполняемое для задания.

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

  Parameters

  • value: number

  Returns void

authorId

• get authorId(): null | string

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

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

  Parameters

  • value: null | string

  Returns void

authorName

• get authorName(): null | string

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

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

  Parameters

  • value: null | string

  Returns void

calendarId

• get calendarId(): null | string

  ID календаря.

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

  Parameters

  • value: null | string

  Returns void

calendarName

• get calendarName(): null | string

  Название календаря.

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

  Parameters

  • value: null | string

  Returns void

canPostpone

• get canPostpone(): boolean

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

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

  Parameters

  • value: boolean

  Returns void

canPostponeEffective

• get canPostponeEffective(): boolean

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

  Returns boolean

card

• get card(): Card

  Карточка задания.

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

  Parameters

  • value: Card

  Returns void

digest

• get digest(): null | string

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

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

  Parameters

  • value: null | string

  Returns void

flags

• get flags(): number

  Флаги задания.

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

  Parameters

  • value: number

  Returns void

formattedPlanned

• get formattedPlanned(): null | string

  Отформатированная строка со сроком исполнения задания.

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

  Parameters

  • value: null | string

  Returns void

groupRowId

• get groupRowId(): string

  Идентификатор группы истории заданий.

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

  Parameters

  • value: string

  Returns void

historyItemParentRowId

• get historyItemParentRowId(): null | string

  Ссылка на родительскую запись в истории заданий, которая учитывается только при автоматическом создании записи в истории заданий в процессе сохранения карточки. При создании и загрузке карточки поле не заполняется и равно null.

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

  Parameters

  • value: null | string

  Returns void

historySettings

• get historySettings(): null | IStorage

  Настройки записи истории задания, сериализуемые в JSON, которые учитывается только при автоматическом создании записи в истории заданий в процессе сохранения задания. При создании и загрузке задания поле не заполняется и равно null.

  Returns null | IStorage
• set historySettings(value: null | IStorage): void

  Parameters

  • value: null | IStorage

  Returns void

inProgress

• get inProgress(): null | string

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

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

  Parameters

  • value: null | string

  Returns void

isCanPerform

• get isCanPerform(): boolean

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

  Returns boolean

isCanPerformAsDeputy

• get isCanPerformAsDeputy(): boolean

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

  Returns boolean

isLocked

• get isLocked(): boolean

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

  Returns boolean

isLockedEffective

• get isLockedEffective(): boolean

  Режим просмотра isLocked, полученный с учётом признака isLockedExplicit.

  Returns boolean

isPostponed

• get isPostponed(): boolean

  Задание отложено. Флаг устанавливается при загрузке и не влияет на сохранение.

  Returns boolean

isSystem

• get isSystem(): boolean

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

  Returns boolean

optionId

• get optionId(): null | string

  Идентификатор варианта завершения задания, или null, если для задания ещё не был определён вариант завершения.

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

  Parameters

  • value: null | string

  Returns void

parentRowId

• get parentRowId(): null | string

  Ссылка на родительское задание.

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

  Parameters

  • value: null | string

  Returns void

planned

• get planned(): null | string

  Дата запланированного завершения задания или null, если задание ещё не было создано.

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

  Parameters

  • value: null | string

  Returns void

plannedQuants

• get plannedQuants(): null | number

  Количество квантов календаря от времени на момент загрузки задания до времени его запланированного завершения planned или null, если задание ещё не было создано.

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

  Parameters

  • value: null | number

  Returns void

plannedType

• get plannedType(): CardTaskPlannedType

  Тип запланированного времени. В зависимости от указанного - трактует planned, как время исполнителя или автора.

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

  Parameters

  • value: CardTaskPlannedType

  Returns void

plannedWorkingDays

• get plannedWorkingDays(): null | number

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

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

  Parameters

  • value: null | number

  Returns void

postponeComment

• get postponeComment(): null | string

  Комментарий по откладыванию задания или null, если задание не было отложено или пользователь не задал комментария.

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

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

  Parameters

  • value: null | string

  Returns void

postponed

• get postponed(): null | string

  Дата и время, когда было отложено задание, или null, если задание не было отложено.

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

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

  Parameters

  • value: null | string

  Returns void

postponedTo

• get postponedTo(): null | string

  Дата и время, до которого было отложено задание, или null, если задание не было отложено.

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

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

  Parameters

  • value: null | string

  Returns void

processId

• get processId(): null | string

  Идентификатор бизнес-процесса, к которому относится запись в истории заданий, которая будет добавлена для задания, или null, если запись не относится к бизнес-процессу.

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

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

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

  Parameters

  • value: null | string

  Returns void

processKind

• get processKind(): null | string

  Тип бизнес-процесса, к которому относится запись в истории заданий, которая будет добавлена для задания, или null, если запись не относится к бизнес-процессу или не содержит информации по его типу.

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

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

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

  Parameters

  • value: null | string

  Returns void

processName

• get processName(): null | string

  Отображаемое имя бизнес-процесса, к которому относится запись в истории заданий, которая будет добавлена для задания, или null, если запись не относится к бизнес-процессу.

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

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

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

  Parameters

  • value: null | string

  Returns void

result

• get result(): null | string

  Результат завершения задания, или null, если либо задание не завершается, либо результат устанавливается серверными расширениями или не устанавливается вообще.

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

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

  Parameters

  • value: null | string

  Returns void

rowId

• get rowId(): string

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

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

  Parameters

  • value: string

  Returns void

sectionRows

• get sectionRows(): StorageMap<CardRow>

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

  Returns StorageMap<CardRow>
• set sectionRows(value: StorageMap<CardRow>): void

  Parameters

  • value: StorageMap<CardRow>

  Returns void

settings

• get settings(): null | IStorage

  Настройки задания.

  Returns null | IStorage
• set settings(value: null | IStorage): void

  Parameters

  • value: null | IStorage

  Returns void

state

• get state(): CardRowState

  Состояние строки с заданием.

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

  Parameters

  • value: CardRowState

  Returns void

storedState

• get storedState(): CardTaskState

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

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

  Parameters

  • value: CardTaskState

  Returns void

taskAssignedRoles

• get taskAssignedRoles(): StorageArray<CardTaskAssignedRole>

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

  Returns StorageArray<CardTaskAssignedRole>
• set taskAssignedRoles(value: CardTaskAssignedRole[]): void

  Parameters

  • value: CardTaskAssignedRole[]

  Returns void

taskSessionRoles

• get taskSessionRoles(): StorageArray<CardTaskSessionRole>

  Список RowID ролей задания, к которым относится текущая сессия.

  Returns StorageArray<CardTaskSessionRole>
• set taskSessionRoles(value: CardTaskSessionRole[]): void

  Parameters

  • value: CardTaskSessionRole[]

  Returns void

timeZoneId

• get timeZoneId(): null | number

  Идентификатор временной зоны задания.

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

  Parameters

  • value: null | number

  Returns void

timeZoneUtcOffsetMinutes

• get timeZoneUtcOffsetMinutes(): null | number

  Смещение временной зоны задания.

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

  Parameters

  • value: null | number

  Returns void

typeCaption

• get typeCaption(): string

  Отображаемое имя типа задания.

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

  Parameters

  • value: string

  Returns void

typeId

• get typeId(): string

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

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

  Parameters

  • value: string

  Returns void

typeName

• get typeName(): string

  Имя типа задания.

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

  Parameters

  • value: string

  Returns void

userId

• get userId(): null | string

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

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

  Parameters

  • value: null | string

  Returns void

userName

• get userName(): null | string

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

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

  Parameters

  • value: null | string

  Returns void

addAuthor

• addAuthor(
      authorId: string,
      authorName?: null | string,
      authorPosition?: null | string,
  ): CardTaskAssignedRole

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

  Parameters

  • authorId: string

    Идентификатор роли автора задания.
  • OptionalauthorName: null | string

    Имя роли автора задания. Если не задано, система определяет его автоматически.
  • OptionalauthorPosition: null | string

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

  Returns CardTaskAssignedRole

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

addPerformer

• addPerformer(
      roleId: string,
      roleName?: null | string,
      master?: boolean,
  ): CardTaskAssignedRole

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

  Parameters

  • roleId: string

    Идентификатор роли исполнителя.
  • OptionalroleName: null | string

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

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

  Returns CardTaskAssignedRole

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

addRole

• addRole(
      roleId: string,
      roleName: string,
      functionRoleId: string,
      parentRowId?: null | string,
      showInTaskDetails?: null | boolean,
      master?: boolean,
  ): CardTaskAssignedRole

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

  Parameters

  • roleId: string

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

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

    ID функциональной роли для добавляемой записи.
  • OptionalparentRowId: null | string

    RowId родительской записи.
  • OptionalshowInTaskDetails: null | boolean

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

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

  Returns CardTaskAssignedRole

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

clean

• clean(): void

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

  Returns void

clearPendingChangesAndCard

• clearPendingChangesAndCard(): void

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

  Returns void

clone

• clone(): CardTask

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

  Returns CardTask

ensureCacheResolved

• ensureCacheResolved(): void

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

  Returns void

hasChanges

• hasChanges(checkStates?: boolean): boolean

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

  Parameters

  • checkStates: boolean = true

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

  Returns boolean

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

hasPendingStateChanges

• hasPendingStateChanges(): boolean

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

  Returns boolean

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

isEmpty

• isEmpty(): boolean

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

  Returns boolean

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

removeChanges

• removeChanges(deletedHandling?: CardRemoveChangesDeletedHandling): boolean

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

  Parameters

  • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

  Returns boolean

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

setCard

• setCard(card: Card): void

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

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

  Parameters

  • card: Card

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

  Returns void

tryGetCard

• tryGetCard(): null | Card

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

  Returns null | Card

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

tryGetHistorySettings

• tryGetHistorySettings(): null | IStorage

  Returns null | IStorage

tryGetOrCreateCardForStore

• tryGetOrCreateCardForStore(storeMethod?: CardStoreMethod): null | Card

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

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

  Parameters

  • storeMethod: CardStoreMethod = CardStoreMethod.Default

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

  Returns null | Card

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

tryGetSectionRows

• tryGetSectionRows(): null | StorageMap<CardRow, IStorage>

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

  Returns null | StorageMap<CardRow, IStorage>

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

tryGetSettings

• tryGetSettings(): null | IStorage

  Returns null | IStorage

tryGetTaskAssignedRoles

• tryGetTaskAssignedRoles(): null | StorageArray<CardTaskAssignedRole>

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

  Returns null | StorageArray<CardTaskAssignedRole>

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

tryGetTaskSessionFunctionRoleList

• tryGetTaskSessionFunctionRoleList(): null | StorageArray<CardTaskSessionRole>

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

  Returns null | StorageArray<CardTaskSessionRole>

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

updateState

• updateState(): boolean

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

  Returns boolean

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