001/*
002 * (C) Copyright 2018 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nelson Silva <[email protected]>
018 */
019package org.nuxeo.ecm.core.api;
020
021import java.io.Serializable;
022import javax.validation.constraints.NotNull;
023
024/**
025 * Interface to be implemented by asynchronous services.
026 *
027 * @param <K> type of task id
028 * @param <S> type of status
029 * @param <V> type of result
030 * @since 10.3
031 */
032public interface AsyncService<K extends Serializable, S extends AsyncStatus<K>, V> {
033
034    /**
035     * Returns the status of a task.
036     */
037    @NotNull
038    S getStatus(K taskId);
039
040    /**
041     * Aborts an asynchronous task. Service should try to cancel the task, if not possible it must try to stop it.
042     */
043    @NotNull
044    S abort(K taskId);
045
046    /**
047     * Retrieves the command execution result.
048     */
049    V getResult(K taskId);
050}