@wshcmx/types/lib/xml/education_plan/index.d.ts

<h1 align="center">WT Types</h1> <div align="center"> Typescript типы для WebSoft HCM.

interface EducationPlanDocumentProgramStartLearningTask {
  learning_task_id: XmlElem<number | null, LearningTaskCatalogDocumentTopElem>;
}

interface EducationPlanDocumentProgramStartAssessment {
  assessment_id: XmlElem<number | null, AssessmentCatalogDocumentTopElem>;
}

interface EducationPlanDocumentProgramFinishLearningTask {
  learning_task_id: XmlElem<number | null, LearningTaskCatalogDocumentTopElem>;
}

interface EducationPlanDocumentProgramFinishAssessment {
  assessment_id: XmlElem<number | null, AssessmentCatalogDocumentTopElem>;
}

interface EducationPlanDocumentProgramFinishNotifiation {
  /** Шаблон уведомления */
  notification_template_id: XmlElem<number | null, NotificationTemplateCatalogDocumentTopElem>;
  /** Тема */
  subject: XmlElem<string | null>;
  /** Сообщение */
  body: XmlElem<string | null>;
  /**
   * Формат сообщения
   * @default plane
   */
  body_type: XmlElem<string | null>;
  /**
   * Редактировать уведомление
   * @default false
   */
  edit_notification: XmlElem<boolean>;
}

interface EducationPlanDocumentProgramStartNotifiation {
  /** Шаблон уведомления */
  notification_template_id: XmlElem<number | null, NotificationTemplateCatalogDocumentTopElem>;
  /** Тема */
  subject: XmlElem<string | null>;
  /** Сообщение */
  body: XmlElem<string | null>;
  /**
   * Формат сообщения
   * @default plane
   */
  body_type: XmlElem<string | null>;
  /**
   * Редактировать уведомление
   * @default false
   */
  edit_notification: XmlElem<boolean>;
}

interface EducationPlanDocumentProgramResultObject {
  /** Объект */
  object_id: XmlElem<number | null>;
  /**
   * Тип результата
   * @default active_learning
   */
  result_type: XmlElem<string | null, typeof common.exchange_object_types>;
  /** Объект */
  result_object_id: XmlElem<number | null>;
}

interface EducationPlanDocumentProgramView {
  /**
   * Тип результата
   * @default active_learning
   */
  result_object_type: XmlElem<string | null, typeof common.exchange_object_types>;
  /** Объект */
  result_object_id: XmlElem<number | null>;
}

interface EducationPlanDocumentProgramCompletedParentProgram {
  program_id: XmlElem<number | null>;
}

interface EducationPlanDocumentProgramProgramResult {
  /** Сотрудник */
  person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
  type: XmlElem<string | null>;
  /** Дата создания */
  date: XmlElem<Date | null>;
}

interface EducationPlanDocumentProgram extends CustomElemsBase {
  id: XmlElem<number | null>;
  /** Название */
  name: XmlElem<string | null>;
  /** Корневой раздел */
  parent_progpam_id: XmlElem<number | null>;
  /** Учебная программа */
  education_method_id: XmlElem<number | null, EducationMethodCatalogDocumentTopElem>;
  /** Набор программ */
  education_program_id: XmlElem<number | null, EducationProgramCatalogDocumentTopElem>;
  /** Доступ после завершения разделов */
  start_learning_tasks: XmlMultiElem<EducationPlanDocumentProgramStartLearningTask | null>;
  /** Доступ после завершения разделов */
  start_assessments: XmlMultiElem<EducationPlanDocumentProgramStartAssessment | null>;
  /** Доступ после завершения разделов */
  finish_learning_tasks: XmlMultiElem<EducationPlanDocumentProgramFinishLearningTask | null>;
  /** Доступ после завершения разделов */
  finish_assessments: XmlMultiElem<EducationPlanDocumentProgramFinishAssessment | null>;
  /** Пост-рассылка */
  finish_notifiation: XmlElem<EducationPlanDocumentProgramFinishNotifiation | null>;
  /** Пред-рассылка */
  start_notifiation: XmlElem<EducationPlanDocumentProgramStartNotifiation | null>;
  /**
   * Тип
   * @default folder
   */
  type: XmlElem<string | null>;
  /** Объект */
  object_id: XmlElem<number | null>;
  /** Название объекта */
  object_name: XmlElem<string | null>;
  /** Код */
  object_code: XmlElem<string | null>;
  object_start_date: XmlElem<Date | null>;
  catalog_name: XmlElem<string | null, typeof common.learning_catalogs>;
  /** Тема */
  subject: XmlElem<string | null>;
  /** Сообщение */
  body: XmlElem<string | null>;
  /**
   * Формат сообщения
   * @default plane
   */
  body_type: XmlElem<string | null>;
  /**
   * Редактировать уведомление
   * @default false
   */
  edit_notification: XmlElem<boolean>;
  /** Дней */
  delay_days: XmlElem<number | null>;
  /** Дней */
  days: XmlElem<number | null>;
  /** Дата создания */
  create_date: XmlElem<Date | null>;
  /** Дата завершения */
  finish_date: XmlElem<Date | null>;
  /** Планируемая дата */
  plan_date: XmlElem<Date | null>;
  /**
   * Тип результата
   * @default active_learning
   */
  result_type: XmlElem<string | null, typeof common.exchange_object_types>;
  /** Объект */
  result_object_id: XmlElem<number | null>;
  /** Название объекта */
  result_object_name: XmlElem<string | null>;
  /** Код */
  result_object_code: XmlElem<string | null>;
  result_object_start_date: XmlElem<Date | null>;
  result_object_finish_date: XmlElem<Date | null>;
  /** Результаты */
  result_objects: XmlMultiElem<EducationPlanDocumentProgramResultObject | null>;
  /**
   * Статус
   * @default 0
   */
  state_id: XmlElem<number, typeof common.education_learning_states>;
  /** Ответственный */
  tutor_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
  /** Вес, % */
  weight: XmlElem<number | null>;
  /** Процент готовности */
  readiness_percent: XmlElem<number | null>;
  start_type: XmlElem<string | null>;
  /** Оценка */
  mark: XmlElem<number | null>;
  /** @temp */
  view: XmlElem<EducationPlanDocumentProgramView | null>;
  /** Незаконченный электронный курс */
  active_learning_id: XmlElem<number | null, ActiveLearningCatalogDocumentTopElem>;
  /** Электронный курс */
  learning_id: XmlElem<number | null, LearningCatalogDocumentTopElem>;
  request_id: XmlElem<number | null, RequestCatalogDocumentTopElem>;
  /** Комментарий */
  comment: XmlElem<string | null>;
  /**
   * Обязательный раздел
   * @default true
   */
  required: XmlElem<boolean>;
  /** Доступ после завершения разделов */
  completed_parent_programs: XmlMultiElem<EducationPlanDocumentProgramCompletedParentProgram | null>;
  /** Результаты этапа */
  program_results: XmlMultiElem<EducationPlanDocumentProgramProgramResult | null>;
}

interface EducationPlanDocumentView {
  /**
   * @temp
   * @default 0
   */
  part_index: XmlElem<number>;
}

type EducationPlanDocumentTopElem = XmlTopElem &
ObjectCodeNameBase &
PersonFillingBase &
AdminAccessBase &
FileListBase &
CustomElemsBase & {
  Doc: EducationPlanDocument;
  /** Группа */
  group_id: XmlElem<number | null, GroupCatalogDocumentTopElem>;
  /** Модульная программа */
  compound_program_id: XmlElem<number | null, CompoundProgramCatalogDocumentTopElem>;
  /**
   * Тип
   * @default collaborator
   */
  type: XmlElem<string | null, typeof common.exchange_object_types>;
  /** Сотрудник */
  person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
  /** Объект */
  object_id: XmlElem<number | null>;
  /** Название объекта */
  object_name: XmlElem<string | null>;
  /** Ответственный */
  tutor_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
  /**
   * Обновлять статусы и активности онлайн
   * @default true
   */
  update_status_and_activity: XmlElem<boolean>;
  /**
   * Строгий контроль дат начала обучения
   * @default true
   */
  strong_date_control: XmlElem<boolean>;
  /** Дата создания */
  create_date: XmlElem<Date | null>;
  /** Дата завершения */
  finish_date: XmlElem<Date | null>;
  /** Фактическая дата завершения */
  fact_finish_date: XmlElem<Date | null>;
  /** Последняя активность */
  last_activity_date: XmlElem<Date | null>;
  /** Планируемая дата */
  plan_date: XmlElem<Date | null>;
  /** Общая оценка */
  mark: XmlElem<number | null>;
  /** Мероприятие */
  event_id: XmlElem<number | null, EventCatalogDocumentTopElem>;
  /** Процент готовности */
  readiness_percent: XmlElem<number | null>;
  /**
   * Статус
   * @default 0
   */
  state_id: XmlElem<number, typeof common.education_learning_states>;
  /** Статус */
  last_state_id: XmlElem<number | null, typeof common.education_learning_states>;
  /** Разделы плана */
  programs: XmlMultiElem<EducationPlanDocumentProgram | null>;
  calculate_state_id(): unknown;
  /** План развития */
  development_plan_id: XmlElem<number | null, DevelopmentPlanCatalogDocumentTopElem>;
  /** Бюджетный период */
  budget_period_id: XmlElem<number | null, BudgetPeriodCatalogDocumentTopElem>;
  /** Процедура */
  assessment_appraise_id: XmlElem<number | null, AssessmentAppraiseCatalogDocumentTopElem>;
  /** Информация об объекте */
  doc_info: XmlElem<DocInfoBase | null>;
  /** Комментарий */
  comment: XmlElem<string | null>;
  /** @temp */
  view: XmlElem<EducationPlanDocumentView | null>;
  getEducationPlanAccess(objId: number, userId: number, objectTopElem: XmlTopElem): unknown;
  calculateMark(): EducationPlanDocument;
};

type EducationPlanDocument = XmlDocument & {
  TopElem: EducationPlanDocumentTopElem;
  education_plan: EducationPlanDocumentTopElem;
  OnBeforeSave(): void;
  DocDesc(): string;
};