/**
 * 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.
 */
package org.apache.aurora.scheduler.storage.db;

import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.annotation.Nullable;

import org.apache.aurora.gen.JobKey;
import org.apache.aurora.scheduler.storage.db.views.DbScheduledTask;
import org.apache.aurora.scheduler.storage.entities.IScheduledTask;
import org.apache.aurora.scheduler.storage.entities.ITaskEvent;
import org.apache.aurora.scheduler.storage.entities.ITaskQuery;
import org.apache.ibatis.annotations.Param;

/**
 * MyBatis mapper for scheduled tasks.
 */
interface TaskMapper {

  /**
   * Inserts a scheduled task.
   *
   * @param task Task to insert.
   */
  void insertScheduledTask(
      @Param("task") IScheduledTask task,
      @Param("configId") long configId,
      @Param("result") InsertResult result);

  /**
   * Gets tasks based on a query.
   *
   * @param query Query to use as a filter for tasks.
   * @return Tasks matching the query.
   */
  List<DbScheduledTask> select(ITaskQuery query);

  /**
   * Gets a task by ID.
   *
   * @param taskId ID of the task to fetch.
   * @return Task with the specified ID.
   */
  @Nullable
  DbScheduledTask selectById(@Param("taskId") String taskId);

  /**
   * Gets job keys of all stored tasks.
   *
   * @return Job keys.
   */
  Set<JobKey> selectJobKeys();

  /**
   * Inserts the task events association within an
   * {@link org.apache.aurora.scheduler.storage.entities.IScheduledTask}.
   *
   * @param taskRowId Task row ID.
   * @param events Events to insert.
   */
  void insertTaskEvents(
      @Param("taskRowId") long taskRowId,
      @Param("events") List<ITaskEvent> events);

  /**
   * Inserts the assigned ports association within an
   * {@link org.apache.aurora.scheduler.storage.entities.IScheduledTask}.
   *
   * @param taskRowId Task row ID.
   * @param ports Assigned ports to insert.
   */
  void insertPorts(@Param("taskRowId") long taskRowId, @Param("ports") Map<String, Integer> ports);

  /**
   * Deletes all task rows.
   */
  void truncate();

  /**
   * Deletes task rows by ID.
   *
   * @param taskIds IDs of tasks to delete.
   */
  void deleteTasks(@Param("taskIds") Set<String> taskIds);
}