Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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.io.Serializable;
import org.camunda.bpm.engine.ProcessEngineConfiguration;
import org.camunda.bpm.engine.exception.NotValidException;
import org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl;
import org.camunda.bpm.engine.query.Query;
/**
* @author Roman Smirnov
*
*/
public interface CaseExecutionQuery extends Query {
/**
* Only select case executions which have the given case instance id.
*
* @param caseInstanceId the id of the case instance
*
* @throws NotValidException when the given case instance id is null
*
*/
CaseExecutionQuery caseInstanceId(String caseInstanceId);
/**
* Only select case executions which have the given case definition id.
*
* @param caseDefinitionId the id of the case definition
*
* @throws NotValidException when the given case definition id is null
*
*/
CaseExecutionQuery caseDefinitionId(String caseDefinitionId);
/**
* Only select case executions which have the given case definition key.
*
* @param caseDefinitionKey the key of the case definition
*
* @throws NotValidException when the given case definition key is null
*
*/
CaseExecutionQuery caseDefinitionKey(String caseDefinitionKey);
/**
* Only select case executions that belong to a case instance with the given business key
*
* @param caseInstanceBusinessKey the business key of the case instance
*
* @throws NotValidException when the given case instance business key is null
*
*/
CaseExecutionQuery caseInstanceBusinessKey(String caseInstanceBusinessKey);
/**
* Only select case executions with the given id.
*
* @param executionId the id of the case execution
*
* @throws NotValidException when the given case execution id is null
*
*/
CaseExecutionQuery caseExecutionId(String executionId);
/**
* Only select case executions which contain an activity with the given id.
*
* @param activityId the id of the activity
*
* @throws NotValidException when the given activity id is null
*
*/
CaseExecutionQuery activityId(String activityId);
/** Only select case executions which are required. **/
CaseExecutionQuery required();
/** Only select case executions which are available. **/
CaseExecutionQuery available();
/** Only select case executions which are enabled. **/
CaseExecutionQuery enabled();
/** Only select case executions which are active. **/
CaseExecutionQuery active();
/** Only select case executions which are disabled. **/
CaseExecutionQuery disabled();
/**
* The query will match the names of variables in a case-insensitive way.
*/
CaseExecutionQuery matchVariableNamesIgnoreCase();
/**
* The query will match the values of variables in a case-insensitive way.
*/
CaseExecutionQuery matchVariableValuesIgnoreCase();
/**
* Only select case executions which have a local variable with the given value. The type
* of variable is determined based on the value, using types configured in
* {@link ProcessEngineConfigurationImpl#getVariableSerializers()}.
*
* Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable
*
* @throws NotValidException when the given name is null
*
*/
CaseExecutionQuery variableValueEquals(String name, Object value);
/**
* Only select case executions which have a local variable with the given name, but
* with a different value than the passed value.
*
* Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable
*
* @throws NotValidException when the given name is null
*
*/
CaseExecutionQuery variableValueNotEquals(String name, Object value);
/**
* Only select case executions which have a variable value greater than the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery variableValueGreaterThan(String name, Object value);
/**
* Only select case executions which have a local variable value greater than or equal to
* the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which
* are not primitive type wrappers) are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery variableValueGreaterThanOrEqual(String name, Object value);
/**
* Only select case executions which have a local variable value less than the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery variableValueLessThan(String name, Object value);
/**
* Only select case executions which have a local variable value less than or equal to the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery variableValueLessThanOrEqual(String name, Object value);
/**
* Only select case executions which have a local variable value like the given value.
*
* This can be used on string variables only.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null. The string can include the
* wildcard character '%' to express like-strategy:
* starts with (string%), ends with (%string) or contains (%string%).
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery variableValueLike(String name, String value);
/**
* Only select case executions which are part of a case instance that have a variable
* with the given name set to the given value. The type of variable is determined based
* on the value, using types configured in {@link ProcessEngineConfiguration#getVariableSerializers()}.
*
* Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable
*
* @throws NotValidException when the given name is null
*
*/
CaseExecutionQuery caseInstanceVariableValueEquals(String name, Object value);
/**
* Only select case executions which are part of a case instance that have a variable
* with the given name, but with a different value than the passed value.
*
* Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable
*
* @throws NotValidException when the given name is null
*
*/
CaseExecutionQuery caseInstanceVariableValueNotEquals(String name, Object value);
/**
* Only select case executions which are part of a case instance that have a variable
* with the given name and a variable value greater than the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery caseInstanceVariableValueGreaterThan(String name, Object value);
/**
* Only select case executions which are part of a case instance that have a
* variable value greater than or equal to the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which
* are not primitive type wrappers) are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery caseInstanceVariableValueGreaterThanOrEqual(String name, Object value);
/**
* Only select case executions which are part of a case instance that have a variable
* value less than the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery caseInstanceVariableValueLessThan(String name, Object value);
/**
* Only select case executions which are part of a case instance that have a variable
* value less than or equal to the passed value.
*
* Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
* are not supported.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery caseInstanceVariableValueLessThanOrEqual(String name, Object value);
/**
* Only select case executions which are part of a case instance that have a variable value
* like the given value.
*
* This can be used on string variables only.
*
* @param name the name of the variable, cannot be null
* @param value the value of the variable, cannot be null. The string can include the
* wildcard character '%' to express like-strategy:
* starts with (string%), ends with (%string) or contains (%string%).
*
* @throws NotValidException when the given name is null or a null-value or a boolean-value is used
*
*/
CaseExecutionQuery caseInstanceVariableValueLike(String name, String value);
/** Only select case execution with one of the given tenant ids. */
CaseExecutionQuery tenantIdIn(String... tenantIds);
/** Only select case executions which have no tenant id. */
CaseExecutionQuery withoutTenantId();
// ordering //////////////////////////////////////////////////////////////
/** Order by id (needs to be followed by {@link #asc()} or {@link #desc()}). */
CaseExecutionQuery orderByCaseExecutionId();
/** Order by case definition key (needs to be followed by {@link #asc()} or {@link #desc()}). */
CaseExecutionQuery orderByCaseDefinitionKey();
/** Order by case definition id (needs to be followed by {@link #asc()} or {@link #desc()}). */
CaseExecutionQuery orderByCaseDefinitionId();
/**
* Order by tenant id (needs to be followed by {@link #asc()} or {@link #desc()}).
* Note that the ordering of case executions without tenant id is database-specific.
*/
CaseExecutionQuery orderByTenantId();
}
