org.camunda.bpm.engine.history.HistoricJobLogQuery 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.history;
import org.camunda.bpm.engine.query.Query;
/**
* @author Roman Smirnov
*
*/
public interface HistoricJobLogQuery extends Query {
/** Only select historic job log entries with the id. */
HistoricJobLogQuery logId(String logId);
/** Only select historic job log entries with the given job id. */
HistoricJobLogQuery jobId(String jobId);
/** Only select historic job log entries with the given exception message. */
HistoricJobLogQuery jobExceptionMessage(String exceptionMessage);
/** Only select historic job log entries with the given job definition id. */
HistoricJobLogQuery jobDefinitionId(String jobDefinitionId);
/** Only select historic job log entries with the given job definition type. */
HistoricJobLogQuery jobDefinitionType(String jobDefinitionType);
/** Only select historic job log entries with the given job definition configuration type. */
HistoricJobLogQuery jobDefinitionConfiguration(String jobDefinitionConfiguration);
/** Only select historic job log entries which are associated with one of the given activity ids. **/
HistoricJobLogQuery activityIdIn(String... activityIds);
/** Only select historic job log entries which are associated with failures of one of the given activity ids. **/
HistoricJobLogQuery failedActivityIdIn(String... activityIds);
/** Only select historic job log entries which are associated with one of the given execution ids. **/
HistoricJobLogQuery executionIdIn(String... executionIds);
/** Only select historic job log entries with the process instance id. */
HistoricJobLogQuery processInstanceId(String processInstanceId);
/** Only select historic job log entries with the process definition id. */
HistoricJobLogQuery processDefinitionId(String processDefinitionId);
/** Only select historic job log entries with the process instance key. */
HistoricJobLogQuery processDefinitionKey(String processDefinitionKey);
/** Only select historic job log entries with the deployment id. */
HistoricJobLogQuery deploymentId(String deploymentId);
/** Only select historic job log entries that belong to one of the given tenant ids. */
HistoricJobLogQuery tenantIdIn(String... tenantIds);
/** Only selects historic job log entries that have no tenant id. */
HistoricJobLogQuery withoutTenantId();
/** Only selects historic job log entries that belong to the given host name. */
HistoricJobLogQuery hostname(String hostname);
/**
* Only select log entries where the job had a priority higher than or
* equal to the given priority.
*
* @since 7.4
*/
HistoricJobLogQuery jobPriorityHigherThanOrEquals(long priority);
/**
* Only select log entries where the job had a priority lower than or
* equal to the given priority.
*
* @since 7.4
*/
HistoricJobLogQuery jobPriorityLowerThanOrEquals(long priority);
/** Only select created historic job log entries. */
HistoricJobLogQuery creationLog();
/** Only select failed historic job log entries. */
HistoricJobLogQuery failureLog();
/**
* Only select historic job logs which belongs to a
* successful executed job.
*/
HistoricJobLogQuery successLog();
/** Only select deleted historic job log entries. */
HistoricJobLogQuery deletionLog();
/** Order by timestamp (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByTimestamp();
/** Order by job id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByJobId();
/** Order by job due date (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByJobDueDate();
/** Order by job retries (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByJobRetries();
/**
* Order by job priority (needs to be followed by {@link #asc()} or {@link #desc()}).
*
* @since 7.4
*/
HistoricJobLogQuery orderByJobPriority();
/** Order by job definition id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByJobDefinitionId();
/** Order by activity id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByActivityId();
/** Order by execution id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByExecutionId();
/** Order by process instance id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByProcessInstanceId();
/** Order by process definition id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByProcessDefinitionId();
/** Order by process definition key (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByProcessDefinitionKey();
/** Order by deployment id (needs to be followed by {@link #asc()} or {@link #desc()}). */
HistoricJobLogQuery orderByDeploymentId();
/**
* Sort the {@link HistoricJobLog historic job logs} in the order in which
* they occurred and needs to be followed by {@link #asc()} or {@link #desc()}.
*
* The set of all {@link HistoricJobLog historic job logs} is a partially ordered
* set. Due to this fact {@link HistoricJobLog historic job logs} with different
* {@link HistoricJobLog#getJobId() job ids} are incomparable. Only {@link
* HistoricJobLog historic job logs} with the same {@link HistoricJobLog#getJobId() job id} can
* be totally ordered by using {@link #jobId(String)} and {@link #orderPartiallyByOccurrence()}
* which will return a result set ordered by its occurrence.
*
* @since 7.3
*/
HistoricJobLogQuery orderPartiallyByOccurrence();
/**
* Order by tenant id (needs to be followed by {@link #asc()} or {@link #desc()}).
* Note that the ordering of job log entries without tenant id is database-specific.
*/
HistoricJobLogQuery orderByTenantId();
/**
* Order by hostname (needs to be followed by {@link #asc()} or {@link #desc()}).
* Note that the ordering of job log entries without hostname is database-specific.
*/
HistoricJobLogQuery orderByHostname();
}