org.camunda.bpm.engine.management.SetJobRetriesBuilder 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-alpha1
/*
 * 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.Date;
import java.util.List;

import org.camunda.bpm.engine.ManagementService;
import org.camunda.bpm.engine.ProcessEngineConfiguration;
import org.camunda.bpm.engine.ProcessEngineException;
import org.camunda.bpm.engine.runtime.Job;

/**
 * Fluent builder to update the number of retries for one or multiple jobs synchronously.
 */
public interface SetJobRetriesBuilder {

  /**
   * Specifies a single {@link Job} by it's ID for the set retries action.
   *
   * Note: Only one method of referencing jobs is allowed. If you use jobId, you can not use jobIds or jobDefinitionId.
   *
   * @param jobId the Id of the job. Must not be null or empty ("").
   *
   * @see ManagementService#setJobRetries(String, int)
   *
   * @return the builder instance
   */
  SetJobRetriesBuilder jobId(String jobId);

  /**
   * Specifies a list of {@link Job jobs} by their IDs for the set retries action.
   *
   * Note: Only one method of referencing jobs is allowed. If you use jobIds, you can not use jobId or jobDefinitionId.
   *
   * @see ManagementService#setJobRetries(List, int)
   *
   * @param jobIds the list of job ids. Must not be null or empty and only contain valid job ids.
   *
   * @return the builder instance
   */
  SetJobRetriesBuilder jobIds(List jobIds);

  /**
   * Specifies a {@link Job} definition id for the set retries action. All failed {@link Job jobs} with that definition id will be updated.
   *
   * Note: Only one method of referencing jobs is allowed. If you use jobDefinitionId, you can not use jobId or jobId.
   *
   * @see ManagementService#setJobRetriesByJobDefinitionId(String, int)
   *
   * @param jobDefinitionId the job definition id. Must not be null or empty ("").
   *
   * @return the builder instance
   */
  SetJobRetriesBuilder jobDefinitionId(String jobDefinitionId);

  /**
   * Specifies a due date to be set on the referenced {@link Job jobs}.
   *
   * When the number of retries of a job are incremented it is not automatically scheduled for immediate execution.
   * When a {@link Job} is executed is determined by the due date. By setting the due date together with the job retries, the scheduled execution date of the
   * job can be adjusted.
   *
   * @param dueDate The new due date for the updated jobs. If it is null, the due date will be set to null. If
   * {@link ProcessEngineConfiguration#isEnsureJobDueDateNotNull() ensureJobDueDateNotNull} is true, the due date will be set to the current date instead of null.
   *
   * @return the builder instance
   */
  SetJobRetriesBuilder dueDate(Date dueDate);

  /**
   * Closes the fluent builder and executes the instructions.
   *
   * @throws ProcessEngineException Check the builder methods and their linked counterparts in {@link ManagementService} for more detail
   */
  void execute();
}