org.camunda.bpm.engine.runtime.JobQuery Maven / Gradle / Ivy
/*
* 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.runtime;
import java.util.Date;
import java.util.Set;
import org.camunda.bpm.engine.query.Query;
/**
* Allows programmatic querying of {@link Job}s.
*
* @author Joram Barrez
* @author Falko Menge
*/
public interface JobQuery extends Query {
/** Only select jobs with the given id */
JobQuery jobId(String jobId);
/** Only select jobs whose id is in the given set of ids */
JobQuery jobIds(Set ids);
/** Only select jobs which exist for the given job definition id. **/
JobQuery jobDefinitionId(String jobDefinitionId);
/** Only select jobs which exist for the given process instance. **/
JobQuery processInstanceId(String processInstanceId);
/** Only select jobs which exist for any of the given process instance ids */
JobQuery processInstanceIds(Set processInstanceIds);
/** Only select jobs which exist for the given process definition id. **/
JobQuery processDefinitionId(String processDefinitionId);
/** Only select jobs which exist for the given process definition key. **/
JobQuery processDefinitionKey(String processDefinitionKey);
/** Only select jobs which exist for the given execution */
JobQuery executionId(String executionId);
/** Only select jobs which are defined on an activity with the given id. **/
JobQuery activityId(String activityId);
/** Only select jobs which have retries left */
JobQuery withRetriesLeft();
/** Only select jobs which are executable,
* ie. retries > 0 and duedate is null or duedate is in the past **/
JobQuery executable();
/** Only select jobs that are timers.
* Cannot be used together with {@link #messages()} */
JobQuery timers();
/** Only select jobs that are messages.
* Cannot be used together with {@link #timers()} */
JobQuery messages();
/** Only select jobs where the duedate is lower than the given date. */
JobQuery duedateLowerThan(Date date);
/** Only select jobs where the duedate is higher then the given date. */
JobQuery duedateHigherThan(Date date);
/** Only select jobs where the duedate is lower then the given date.
* @deprecated
*/
@Deprecated
JobQuery duedateLowerThen(Date date);
/** Only select jobs where the duedate is lower then or equals the given date.
* @deprecated
*/
@Deprecated
JobQuery duedateLowerThenOrEquals(Date date);
/** Only select jobs where the duedate is higher then the given date.
* @deprecated
*/
@Deprecated
JobQuery duedateHigherThen(Date date);
/** Only select jobs where the duedate is higher then or equals the given date.
* @deprecated
*/
@Deprecated
JobQuery duedateHigherThenOrEquals(Date date);
/** Only select jobs created before the given date. */
JobQuery createdBefore(Date date);
/** Only select jobs created after the given date. */
JobQuery createdAfter(Date date);
/**
* Only select jobs with a priority that is higher than or equal to the given priority.
*
* @since 7.4
*/
JobQuery priorityHigherThanOrEquals(long priority);
/**
* Only select jobs with a priority that is lower than or equal to the given priority.
*
* @since 7.4
*/
JobQuery priorityLowerThanOrEquals(long priority);
/** Only select jobs that failed due to an exception. */
JobQuery withException();
/** Only select jobs that failed due to an exception with the given message. */
JobQuery exceptionMessage(String exceptionMessage);
/** Only select jobs that failed due to an exception at an activity with the given id. **/
JobQuery failedActivityId(String activityId);
/** Only select jobs which have no retries left */
JobQuery noRetriesLeft();
/** Only select jobs that are not suspended. */
JobQuery active();
/** Only select jobs that are suspended. */
JobQuery suspended();
/** Only select jobs that belong to one of the given tenant ids. */
JobQuery tenantIdIn(String... tenantIds);
/** Only select jobs which have no tenant id. */
JobQuery withoutTenantId();
/**
* Select jobs which have no tenant id. Can be used in combination
* with {@link #tenantIdIn(String...)}.
*/
JobQuery includeJobsWithoutTenantId();
//sorting //////////////////////////////////////////
/** Order by job id (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByJobId();
/** Order by duedate (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByJobDuedate();
/** Order by retries (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByJobRetries();
/**
* Order by priority for execution (needs to be followed by {@link #asc()} or {@link #desc()}).
*
* @since 7.4
*/
JobQuery orderByJobPriority();
/** Order by process instance id (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByProcessInstanceId();
/** Order by process definition id (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByProcessDefinitionId();
/** Order by process definition key (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByProcessDefinitionKey();
/** Order by execution id (needs to be followed by {@link #asc()} or {@link #desc()}). */
JobQuery orderByExecutionId();
/**
* Order by tenant id (needs to be followed by {@link #asc()} or {@link #desc()}).
* Note that the ordering of job without tenant id is database-specific.
*/
JobQuery orderByTenantId();
}