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 *     Funsho David
018 */
019package org.nuxeo.ecm.core.bulk;
020
021import java.time.Duration;
022
023/**
024 * API to manage Bulk Computation.
025 *
026 * @since 10.2
027 */
028public interface BulkService {
029
030    /**
031     * Submits a {@link BulkCommand} that will be processed asynchronously.
032     *
033     * @param command the command to submit
034     * @return a unique bulk command identifier
035     */
036    String submit(BulkCommand command);
037
038    /**
039     * @return the command status corresponding to the command identifier.
040     */
041    BulkStatus getStatus(String commandId);
042
043    /**
044     * Waits for completion of given bulk command.
045     *
046     * @param commandId the command to wait
047     * @param duration the duration to wait
048     * @return {@code true} if bulk command completed or {@code false} if computation has not finished after the timeout
049     */
050    boolean await(String commandId, Duration duration) throws InterruptedException;
051}