org.camunda.bpm.engine.management.SetJobRetriesByJobsAsyncBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation

There is a newer version: 7.23.0-alpha2

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.management;

import java.util.List;
import org.camunda.bpm.engine.ManagementService;
import org.camunda.bpm.engine.ProcessEngineException;
import org.camunda.bpm.engine.runtime.JobQuery;

/**
 * Fluent builder to update the number of retries for one or multiple jobs asynchronously.
 */
public interface SetJobRetriesByJobsAsyncBuilder extends SetJobRetriesAsyncBuilder {

  /**
   * Specifies a {@link JobQuery} to reference jobs that will be updated. If this method and {@link #jobIds(List)} is
   * called together, the builder will operate on the jobs referenced by job query and job ids. If neither method is
   * called, a {@link ProcessEngineException} is thrown on {@link #executeAsync()}.
   *
   * @param query
   *          the query to reference jobs that will be updated.
   *
   * @see ManagementService#setJobRetriesAsync(JobQuery, int)
   *
   * @return the builder instance
   */
  SetJobRetriesByJobsAsyncBuilder jobQuery(JobQuery query);

  /**
   * Specifies a list of job ids that will be updated. If this method and {@link #jobQuery(JobQuery)} is called
   * together, the builder will operate on the jobs referenced by job query and job ids. If neither method is called, a
   * {@link ProcessEngineException} is thrown on {@link #executeAsync()}.
   *
   * @param jobIds
   *          The list of job ids that will be updated.
   *
   * @see ManagementService#setJobRetriesAsync(JobQuery, int)
   *
   * @return the builder instance
   */
  SetJobRetriesByJobsAsyncBuilder jobIds(List jobIds);
}