com.powsybl.computation.slurm.SlurmTask Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2020, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package com.powsybl.computation.slurm;

import java.io.IOException;
import java.util.List;
import java.util.concurrent.ExecutionException;

/**
 *
 * Represents a user submitted tasks, which will probably required the execution
 * of multiple underlying individual jobs on the slurm infrastructure.
 *
 * @author Sylvain Leclerc 
 */
public interface SlurmTask {

    /**
     * Submits all jobs required to complete this task to the Slurm infrastructure.
     */
    void submit() throws IOException;

    /**
     * Waits for the whole task to be executed, and generates the execution report.
     *
     * @throws java.util.concurrent.CancellationException if the task has been interrupted by a call to {@link #interrupt()}.
     */
    SlurmExecutionReport await() throws InterruptedException, ExecutionException;

    /**
     * Asks for interruption of the execution of this task,
     * in order to save the infrastructure computation resources.
     *
     * Calls waiting for completion of {@link #await()} will throw a {@link java.util.concurrent.CancellationException}.
     */
    void interrupt();

    /**
     * Provides the list of jobs for which completion status needs to be monitored.
     */
    List getPendingJobs();

}