core/templates/domain/improvements/task-entry.model.ts - develop - githubmirror/oppia

core/templates/domain/improvements/task-entry.model.ts
153 строки5 KB
Nikita Vorobev
Apply prettier 2 (#19862)
12 мар 2024, 19:39
12 мар 2024, 19:392ae9b98
// Copyright 2020 The Oppia Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview Frontend Model for task entry.
 */
import {ImprovementsConstants} from 'domain/improvements/improvements.constants';

/**
 * Encodes the back-end response of a task entry. This interface is intended to
 * be extended with a stronger "TaskType" to help the compiler enforce that the
 * fields are set correctly.
 *
 * When the task type is excluded, it is assumed to be a simple string that can
 * match any task. This is used when, for example, rendering the list of tasks
 * as a table (where the type doesn't matter).
 */
export interface TaskEntryBackendDict<TaskType = string> {
  entity_type: string;
  entity_id: string;
  entity_version: number;
  task_type: TaskType;
  target_type: string;
  target_id: string;
  issue_description: string | null;
  status: string;
  resolver_username: string | null;
  resolved_on_msecs: number | null;
}

/**
 * Encodes the minimal details required to store a task to the back-end. This
 * interface is intended to be extended with a stronger "TaskType" to help the
 * compiler enforce that the fields are set correctly.
 *
 * When the task type is excluded, it is assumed to be a simple string that can
 * match any task. This is used when, for example, rendering the list of tasks
 * as a table (where the type doesn't matter).
 */
export interface TaskEntryPayloadDict<TaskType = string> {
  entity_version: number;
  task_type: TaskType;
  target_id: string;
  issue_description: string | null;
  status: string;
}

/**
 * Encodes a task's management details. This class is intended to be extended
 * with a stronger "TaskType" to help the compiler enforce that the fields are
 * set correctly.
 *
 * When the task type is excluded, it is assumed to be a simple string that can
 * match any task. This is used when, for example, rendering the list of tasks
 * as a table (where the type doesn't matter).
 */
export class TaskEntry<TaskType = string> {
  public readonly entityType: string;
  public readonly entityId: string;
  public readonly entityVersion: number;
  public readonly taskType: TaskType;
  public readonly targetType: string;
  public readonly targetId: string;
  public readonly resolverUsername: string | null;
  public readonly resolvedOnMsecs: number | null;
  protected issueDescription: string | null;
  private taskStatus: string;

  constructor(backendDict: TaskEntryBackendDict<TaskType>) {
    this.entityType = backendDict.entity_type;
    this.entityId = backendDict.entity_id;
    this.entityVersion = backendDict.entity_version;
    this.taskType = backendDict.task_type;
    this.targetType = backendDict.target_type;
    this.targetId = backendDict.target_id;
    this.resolverUsername = backendDict.resolver_username;
    this.resolvedOnMsecs = backendDict.resolved_on_msecs;
    this.issueDescription = backendDict.issue_description;
    this.taskStatus = backendDict.status;
  }

  static createFromBackendDict(backendDict: TaskEntryBackendDict): TaskEntry {
    return new TaskEntry(backendDict);
  }

  public toBackendDict(): TaskEntryBackendDict<TaskType> {
    return {
      entity_type: this.entityType,
      entity_id: this.entityId,
      entity_version: this.entityVersion,
      task_type: this.taskType,
      target_type: this.targetType,
      target_id: this.targetId,
      issue_description: this.issueDescription,
      status: this.taskStatus,
      resolver_username: this.resolverUsername,
      resolved_on_msecs: this.resolvedOnMsecs,
    };
  }

  public toPayloadDict(): TaskEntryPayloadDict<TaskType> {
    return {
      entity_version: this.entityVersion,
      task_type: this.taskType,
      target_id: this.targetId,
      issue_description: this.issueDescription,
      status: this.taskStatus,
    };
  }

  public getStatus(): string {
    return this.taskStatus;
  }

  public getIssueDescription(): string | null {
    return this.issueDescription;
  }

  public isOpen(): boolean {
    return this.taskStatus === ImprovementsConstants.TASK_STATUS_OPEN;
  }

  public isObsolete(): boolean {
    return this.taskStatus === ImprovementsConstants.TASK_STATUS_OBSOLETE;
  }

  public isResolved(): boolean {
    return this.taskStatus === ImprovementsConstants.TASK_STATUS_RESOLVED;
  }

  public markAsObsolete(): void {
    this.taskStatus = ImprovementsConstants.TASK_STATUS_OBSOLETE;
  }

  protected markAsOpen(): void {
    this.taskStatus = ImprovementsConstants.TASK_STATUS_OPEN;
  }

  protected markAsResolved(): void {
    this.taskStatus = ImprovementsConstants.TASK_STATUS_RESOLVED;
  }
}