org.xlcloud.xsa.ext.hpc.api.HpcJobsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hpc-model Show documentation

The newest version!

/*
 * Copyright 2012 AMG.lab, a Bull Group Company
 * 
 * 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.xlcloud.xsa.ext.hpc.api;

import org.xlcloud.xsa.HpcJob;
import org.xlcloud.xsa.HpcJobs;

/**
 * Interface implemented by XSA jobs resource
 * 
 * @author Piotr Kulasek-Szwed, AMG.net
 * @author Krzysztof Szafrański, AMG.net
 */
public interface HpcJobsApi {

    /**
     * List all HPC jobs.
     * 
     * @return list of HPC jobs in {@link HpcJobs} object (or an empty
     *         {@link HpcJobs} wrapper if no jobs exist)
     */
    HpcJobs list();

    /**
     * Get details of specified job.
     * 
     * @param id
     *            job id
     * @return job details wrapped in {@link HpcJob}.
     */
    HpcJob get(String id);

    /**
     * Terminates specified job.
     * 
     * @param id
     *            job id
     */
    void terminate(String id);
}