org.camunda.bpm.engine.impl
Class HistoricDetailQueryImpl

java.lang.Object
  org.camunda.bpm.engine.impl.db.AuthorizationCheck
      org.camunda.bpm.engine.impl.db.ListQueryParameterObject
          org.camunda.bpm.engine.impl.AbstractQuery<HistoricDetailQuery,HistoricDetail>
              org.camunda.bpm.engine.impl.HistoricDetailQueryImpl

All Implemented Interfaces:

Serializable, HistoricDetailQuery, Command<Object>, Query<HistoricDetailQuery,HistoricDetail>

public class HistoricDetailQueryImpl
extends AbstractQuery<HistoricDetailQuery,HistoricDetail>
implements HistoricDetailQuery

Author:

Tom Baeyens

See Also:

Serialized Form

Field Summary

protected String	activityId
protected String	activityInstanceId
protected String	detailId
protected boolean	excludeTaskRelated
protected String	executionId
protected boolean	isByteArrayFetchingEnabled
protected boolean	isCustomObjectDeserializationEnabled
protected String	processInstanceId
protected String	taskId
protected String	type
protected String	variableInstanceId

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandContext, commandExecutor, expressions, orderBy, orderProperty, resultType, SORTORDER_ASC, SORTORDER_DESC

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

databaseType, DEFAULT_ORDER_BY, firstResult, maxResults, parameter

Fields inherited from class org.camunda.bpm.engine.impl.db.AuthorizationCheck

authDefaultPerm, authGroupIds, authPerms, authResourceId, authResourceIdQueryParam, authResourceType, authUserId, isAuthorizationCheckEnabled

Constructor Summary

HistoricDetailQueryImpl()

HistoricDetailQueryImpl(CommandContext commandContext)

HistoricDetailQueryImpl(CommandExecutor commandExecutor)

Method Summary

HistoricDetailQuery	activityId(String activityId) Only select historic variable updates associated to the given activity instance.
HistoricDetailQuery	activityInstanceId(String activityInstanceId) Only select historic variable updates associated to the given activity instance.
HistoricDetailQuery	detailId(String id) Only select the historic detail with the given id.
HistoricDetailQuery	disableBinaryFetching() Disable fetching of byte array values.
HistoricDetailQuery	disableCustomObjectDeserialization() Disable deserialization of variable values that are custom objects.
HistoricDetailQuery	excludeTaskDetails() Exclude all task-related HistoricDetails, so only items which have no task-id set will be selected.
long	executeCount(CommandContext commandContext)
List<HistoricDetail>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
HistoricDetailQuery	executionId(String executionId) Only select historic variable updates with the given execution.
HistoricDetailQuery	formFields() Only select HistoricFormFields.
HistoricDetailQuery	formProperties() Only select HistoricFormPropertys.
String	getActivityId()
String	getDetailId()
boolean	getExcludeTaskRelated()
String	getProcessInstanceId()
String	getTaskId()
String	getType()
HistoricDetailQuery	orderByFormPropertyId()
HistoricDetailQuery	orderByProcessInstanceId()
HistoricDetailQuery	orderByTime()
HistoricDetailQuery	orderByVariableName()
HistoricDetailQuery	orderByVariableRevision()
HistoricDetailQuery	orderByVariableType()
HistoricDetailQuery	processInstanceId(String processInstanceId) Only select historic variable updates with the given process instance.
protected boolean	shouldFetchSerializedValueFor(HistoricDetailVariableInstanceUpdateEntity variableInstance) Eagerly fetch the variable's serialized value unless the type is "bytes" and binary fetching disabled
protected boolean	shouldFetchValueFor(HistoricDetailVariableInstanceUpdateEntity variableInstance) eagerly fetch the variable's value unless the serialized value should not be fetched or custom object fetching is disabled
HistoricDetailQuery	taskId(String taskId) Only select historic variable updates associated to the given historic task instance.
HistoricDetailQuery	variableInstanceId(String variableInstanceId) Only select historic variable updates associated to the given historic variable instance.
HistoricDetailQuery	variableUpdates() Only select HistoricVariableUpdates.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addOrder, asc, checkQueryOk, count, desc, direction, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteList, execute, executeSingleResult, extend, getExpressions, getMethod, getOrderBy, list, listPage, mergeExpressions, mergeOrdering, orderBy, setCommandExecutor, setExpressions, singleResult

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setDatabaseType, setFirstResult, setMaxResults, setOrderBy, setParameter

Methods inherited from class org.camunda.bpm.engine.impl.db.AuthorizationCheck

getAuthDefaultPerm, getAuthGroupIds, getAuthPerms, getAuthResourceId, getAuthResourceIdQueryParam, getAuthResourceType, getAuthUserId, isAuthorizationCheckEnabled, setAuthDefaultPerm, setAuthGroupIds, setAuthorizationCheckEnabled, setAuthPerms, setAuthResourceId, setAuthResourceIdQueryParam, setAuthResourceType, setAuthUserId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult

Field Detail

detailId

protected String detailId

taskId

protected String taskId

processInstanceId

protected String processInstanceId

executionId

protected String executionId

activityId

protected String activityId

activityInstanceId

protected String activityInstanceId

type

protected String type

variableInstanceId

protected String variableInstanceId

excludeTaskRelated

protected boolean excludeTaskRelated

isByteArrayFetchingEnabled

protected boolean isByteArrayFetchingEnabled

isCustomObjectDeserializationEnabled

protected boolean isCustomObjectDeserializationEnabled

Constructor Detail

HistoricDetailQueryImpl

public HistoricDetailQueryImpl()

HistoricDetailQueryImpl

public HistoricDetailQueryImpl(CommandContext commandContext)

HistoricDetailQueryImpl

public HistoricDetailQueryImpl(CommandExecutor commandExecutor)

Method Detail

detailId

public HistoricDetailQuery detailId(String id)

Description copied from interface: HistoricDetailQuery

Only select the historic detail with the given id.

Specified by:

detailId in interface HistoricDetailQuery

Parameters:

id - the historic detail to select

Returns:

the query builder

variableInstanceId

public HistoricDetailQuery variableInstanceId(String variableInstanceId)

Description copied from interface: HistoricDetailQuery

Only select historic variable updates associated to the given historic variable instance.

Specified by:

variableInstanceId in interface HistoricDetailQuery

processInstanceId

public HistoricDetailQuery processInstanceId(String processInstanceId)

Description copied from interface: HistoricDetailQuery

Only select historic variable updates with the given process instance. ProcessInstance) ids and {@link HistoricProcessInstance} ids match.

Specified by:

processInstanceId in interface HistoricDetailQuery

executionId

public HistoricDetailQuery executionId(String executionId)

Description copied from interface: HistoricDetailQuery

Only select historic variable updates with the given execution. Note that Execution ids are not stored in the history as first class citizen, only process instances are.

Specified by:

executionId in interface HistoricDetailQuery

activityId

public HistoricDetailQuery activityId(String activityId)

Description copied from interface: HistoricDetailQuery

Only select historic variable updates associated to the given activity instance.

Specified by:

activityId in interface HistoricDetailQuery

activityInstanceId

public HistoricDetailQuery activityInstanceId(String activityInstanceId)

Description copied from interface: HistoricDetailQuery

Only select historic variable updates associated to the given activity instance.

Specified by:

activityInstanceId in interface HistoricDetailQuery

taskId

public HistoricDetailQuery taskId(String taskId)

Description copied from interface: HistoricDetailQuery

Only select historic variable updates associated to the given historic task instance.

Specified by:

taskId in interface HistoricDetailQuery

formProperties

public HistoricDetailQuery formProperties()

Description copied from interface: HistoricDetailQuery

Only select HistoricFormPropertys.

Specified by:

formProperties in interface HistoricDetailQuery

formFields

public HistoricDetailQuery formFields()

Description copied from interface: HistoricDetailQuery

Only select HistoricFormFields.

Specified by:

formFields in interface HistoricDetailQuery

variableUpdates

public HistoricDetailQuery variableUpdates()

Description copied from interface: HistoricDetailQuery

Only select HistoricVariableUpdates.

Specified by:

variableUpdates in interface HistoricDetailQuery

excludeTaskDetails

public HistoricDetailQuery excludeTaskDetails()

Description copied from interface: HistoricDetailQuery

Exclude all task-related HistoricDetails, so only items which have no task-id set will be selected. When used together with HistoricDetailQuery.taskId(String), this call is ignored task details are NOT excluded.

Specified by:

excludeTaskDetails in interface HistoricDetailQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoricDetailQuery,HistoricDetail>

disableBinaryFetching

public HistoricDetailQuery disableBinaryFetching()

Description copied from interface: HistoricDetailQuery

Disable fetching of byte array values. By default, the query will fetch the value of a byte array. By calling this method you can prevent the values of (potentially large) blob data chunks to be fetched.

Specified by:

disableBinaryFetching in interface HistoricDetailQuery

Returns:

the query builder

disableCustomObjectDeserialization

public HistoricDetailQuery disableCustomObjectDeserialization()

Description copied from interface: HistoricDetailQuery

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.

Specified by:

disableCustomObjectDeserialization in interface HistoricDetailQuery

executeList

public List<HistoricDetail> executeList(CommandContext commandContext,
                                        Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<HistoricDetailQuery,HistoricDetail>

page - used if the results must be paged. If null, no paging will be applied.

shouldFetchValueFor

protected boolean shouldFetchValueFor(HistoricDetailVariableInstanceUpdateEntity variableInstance)

eagerly fetch the variable's value unless the serialized value should not be fetched or custom object fetching is disabled

shouldFetchSerializedValueFor

protected boolean shouldFetchSerializedValueFor(HistoricDetailVariableInstanceUpdateEntity variableInstance)

Eagerly fetch the variable's serialized value unless the type is "bytes" and binary fetching disabled

orderByProcessInstanceId

public HistoricDetailQuery orderByProcessInstanceId()

Specified by:

orderByProcessInstanceId in interface HistoricDetailQuery

orderByTime

public HistoricDetailQuery orderByTime()

Specified by:

orderByTime in interface HistoricDetailQuery

orderByVariableName

public HistoricDetailQuery orderByVariableName()

Specified by:

orderByVariableName in interface HistoricDetailQuery

orderByFormPropertyId

public HistoricDetailQuery orderByFormPropertyId()

Specified by:

orderByFormPropertyId in interface HistoricDetailQuery

orderByVariableRevision

public HistoricDetailQuery orderByVariableRevision()

Specified by:

orderByVariableRevision in interface HistoricDetailQuery

orderByVariableType

public HistoricDetailQuery orderByVariableType()

Specified by:

orderByVariableType in interface HistoricDetailQuery

getProcessInstanceId

public String getProcessInstanceId()

getTaskId

public String getTaskId()

getActivityId

public String getActivityId()

getType

public String getType()

getExcludeTaskRelated

public boolean getExcludeTaskRelated()

getDetailId

public String getDetailId()