org.camunda.bpm.engine.history.HistoricVariableInstanceQuery 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;
/**
* Programmatic querying for {@link HistoricVariableInstance}s.
*
* @author Christian Lipphardt (camunda)
*/
public interface HistoricVariableInstanceQuery extends Query {
/** Only select the variable with the given Id
* @param id of the variable to select
* @return the query object */
HistoricVariableInstanceQuery variableId(String id);
/** Only select historic process variables with the given process instance. */
HistoricVariableInstanceQuery processInstanceId(String processInstanceId);
/** Only select historic process variables for the given process definition */
HistoricVariableInstanceQuery processDefinitionId(String processDefinitionId);
/** Only select historic process variables for the given process definition key */
HistoricVariableInstanceQuery processDefinitionKey(String processDefinitionKey);
/** Only select historic case variables with the given case instance. */
HistoricVariableInstanceQuery caseInstanceId(String caseInstanceId);
/** Only select historic process variables with the given variable name. */
HistoricVariableInstanceQuery variableName(String variableName);
/** Only select historic process variables where the given variable name is like. */
HistoricVariableInstanceQuery variableNameLike(String variableNameLike);
/** Only select historic process variables which match one of the given variable types. */
HistoricVariableInstanceQuery variableTypeIn(String... variableTypes);
/** The query will match the names of task and process variables in a case-insensitive way. */
HistoricVariableInstanceQuery matchVariableNamesIgnoreCase();
/** The query will match the values of task and process variables in a case-insensitive way. */
HistoricVariableInstanceQuery matchVariableValuesIgnoreCase();
/** only select historic process variables with the given name and value */
HistoricVariableInstanceQuery variableValueEquals(String variableName, Object variableValue);
HistoricVariableInstanceQuery orderByProcessInstanceId();
HistoricVariableInstanceQuery orderByVariableName();
/** Only select historic process variables with the given process instance ids. */
HistoricVariableInstanceQuery processInstanceIdIn(String... processInstanceIds);
/** Only select historic variable instances which have one of the task ids. **/
HistoricVariableInstanceQuery taskIdIn(String... taskIds);
/** Only select historic variable instances which have one of the executions ids. **/
HistoricVariableInstanceQuery executionIdIn(String... executionIds);
/** Only select historic variable instances which have one of the case executions ids. **/
HistoricVariableInstanceQuery caseExecutionIdIn(String... caseExecutionIds);
/** Only select historic variable instances with one of the given case activity ids. **/
HistoricVariableInstanceQuery caseActivityIdIn(String... caseActivityIds);
/** Only select historic variable instances which have one of the activity instance ids. **/
HistoricVariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds);
/** Only select historic variable instances with one of the given tenant ids. */
HistoricVariableInstanceQuery tenantIdIn(String... tenantIds);
/** Only selects historic variable instances that have no tenant id. */
HistoricVariableInstanceQuery withoutTenantId();
/**
* Order by tenant id (needs to be followed by {@link #asc()} or {@link #desc()}).
* Note that the ordering of historic variable instances without tenant id is database-specific.
*/
HistoricVariableInstanceQuery orderByTenantId();
/**
* Disable fetching of byte array and file values. By default, the query will fetch such values.
* By calling this method you can prevent the values of (potentially large) blob data chunks
* to be fetched. The variables themselves are nonetheless included in the query result.
*
* @return the query builder
*/
HistoricVariableInstanceQuery disableBinaryFetching();
/**
* Disable deserialization of variable values that are custom objects. By default, the query
* will attempt to deserialize the value of these variables. By calling this method you can
* prevent such attempts in environments where their classes are not available.
* Independent of this setting, variable serialized values are accessible.
*/
HistoricVariableInstanceQuery disableCustomObjectDeserialization();
/**
* Include variables that has been already deleted during the execution
*/
HistoricVariableInstanceQuery includeDeleted();
}