org.camunda.bpm.engine.history.UserOperationLogEntry 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.EntityTypes;
import java.util.Date;
/**
* Log entry about an operation performed by a user. This is used for logging
* actions such as creating a new task, completing a task,
* canceling a process instance, ...
*
* Operation Type
* The type of the operation which has been performed. A user may create a new task,
* complete a task, delegate a tasks, etc... Check this class for a list of built-in
* operation type constants.
*
* Entity Type
* The type of the entity on which the operation was performed. Operations may be
* performed on tasks, attachments, ...
*
* Affected Entity Criteria
*
* The methods that reference other entities (except users), such as {@link #getProcessInstanceId()}
* or {@link #getProcessDefinitionId()}, describe which entities were affected
* by the operation and represent restriction criteria.
* A null return value of any of those methods means that regarding
* this criterion, any entity was affected.
*
*
* For example, if an operation suspends all process instances that belong to a certain
* process definition id, one operation log entry is created.
* Its return value for the method {@link #getProcessInstanceId()} is null,
* while {@link #getProcessDefinitionId()} returns an id. Thus, the return values
* of these methods can be understood as selection criteria of instances of the entity type
* that were affected by the operation.
*
*
* Additional Considerations
* The event describes which user has requested out the operation and the time
* at which the operation was performed. Furthermore, one operation can result in multiple
* {@link UserOperationLogEntry} entities whicha are linked by the value of the
* {@link #getOperationId()} method.
*
* @author Danny Gräf
* @author Daniel Meyer
*
*/
public interface UserOperationLogEntry {
/** @deprecated Please use {@link EntityTypes#TASK} instead. */
@Deprecated
String ENTITY_TYPE_TASK = EntityTypes.TASK;
/** @deprecated Please use {@link EntityTypes#IDENTITY_LINK} instead. */
@Deprecated
String ENTITY_TYPE_IDENTITY_LINK = EntityTypes.IDENTITY_LINK;
/** @deprecated Please use {@link EntityTypes#ATTACHMENT} instead. */
@Deprecated
String ENTITY_TYPE_ATTACHMENT = EntityTypes.ATTACHMENT;
String OPERATION_TYPE_ASSIGN = "Assign";
String OPERATION_TYPE_CLAIM = "Claim";
String OPERATION_TYPE_COMPLETE = "Complete";
String OPERATION_TYPE_CREATE = "Create";
String OPERATION_TYPE_DELEGATE = "Delegate";
String OPERATION_TYPE_DELETE = "Delete";
String OPERATION_TYPE_RESOLVE = "Resolve";
String OPERATION_TYPE_SET_OWNER = "SetOwner";
String OPERATION_TYPE_SET_PRIORITY = "SetPriority";
String OPERATION_TYPE_SET_NAME = "SetName";
String OPERATION_TYPE_SET_DESCRIPTION = "SetDescription";
String OPERATION_TYPE_SET_FOLLOW_UP_DATE = "SetFollowUpDate";
String OPERATION_TYPE_UPDATE = "Update";
String OPERATION_TYPE_ACTIVATE = "Activate";
String OPERATION_TYPE_SUSPEND = "Suspend";
String OPERATION_TYPE_MIGRATE = "Migrate";
String OPERATION_TYPE_ADD_USER_LINK = "AddUserLink";
String OPERATION_TYPE_DELETE_USER_LINK = "DeleteUserLink";
String OPERATION_TYPE_ADD_GROUP_LINK = "AddGroupLink";
String OPERATION_TYPE_DELETE_GROUP_LINK = "DeleteGroupLink";
String OPERATION_TYPE_SET_DUEDATE = "SetDueDate";
String OPERATION_TYPE_RECALC_DUEDATE = "RecalculateDueDate";
String OPERATION_TYPE_UNLOCK = "Unlock";
String OPERATION_TYPE_EXECUTE = "Execute";
String OPERATION_TYPE_EVALUATE = "Evaluate";
String OPERATION_TYPE_ADD_ATTACHMENT = "AddAttachment";
String OPERATION_TYPE_DELETE_ATTACHMENT = "DeleteAttachment";
String OPERATION_TYPE_SUSPEND_JOB_DEFINITION = "SuspendJobDefinition";
String OPERATION_TYPE_ACTIVATE_JOB_DEFINITION = "ActivateJobDefinition";
String OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION = "SuspendProcessDefinition";
String OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION = "ActivateProcessDefinition";
String OPERATION_TYPE_CREATE_HISTORY_CLEANUP_JOB = "CreateHistoryCleanupJobs";
String OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE = "UpdateHistoryTimeToLive";
String OPERATION_TYPE_DELETE_HISTORY = "DeleteHistory";
String OPERATION_TYPE_MODIFY_PROCESS_INSTANCE = "ModifyProcessInstance";
String OPERATION_TYPE_RESTART_PROCESS_INSTANCE = "RestartProcessInstance";
String OPERATION_TYPE_SUSPEND_JOB = "SuspendJob";
String OPERATION_TYPE_ACTIVATE_JOB = "ActivateJob";
String OPERATION_TYPE_SET_JOB_RETRIES = "SetJobRetries";
String OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES = "SetExternalTaskRetries";
String OPERATION_TYPE_SET_VARIABLE = "SetVariable";
String OPERATION_TYPE_SET_VARIABLES = "SetVariables";
String OPERATION_TYPE_REMOVE_VARIABLE = "RemoveVariable";
String OPERATION_TYPE_MODIFY_VARIABLE = "ModifyVariable";
String OPERATION_TYPE_SUSPEND_BATCH = "SuspendBatch";
String OPERATION_TYPE_ACTIVATE_BATCH = "ActivateBatch";
String OPERATION_TYPE_CREATE_INCIDENT = "CreateIncident";
String OPERATION_TYPE_SET_REMOVAL_TIME = "SetRemovalTime";
String OPERATION_TYPE_SET_ANNOTATION = "SetAnnotation";
String OPERATION_TYPE_CLEAR_ANNOTATION = "ClearAnnotation";
String OPERATION_TYPE_CORRELATE_MESSAGE = "CorrelateMessage";
String CATEGORY_ADMIN = "Admin";
String CATEGORY_OPERATOR = "Operator";
String CATEGORY_TASK_WORKER = "TaskWorker";
/** The unique identifier of this log entry. */
String getId();
/** Deployment reference */
String getDeploymentId();
/** Process definition reference. */
String getProcessDefinitionId();
/**
* Key of the process definition this log entry belongs to; null means any.
*/
String getProcessDefinitionKey();
/** Root process instance reference. */
String getRootProcessInstanceId();
/** Process instance reference. */
String getProcessInstanceId();
/** Execution reference. */
String getExecutionId();
/** Case definition reference. */
String getCaseDefinitionId();
/** Case instance reference. */
String getCaseInstanceId();
/** Case execution reference. */
String getCaseExecutionId();
/** Task instance reference. */
String getTaskId();
/** Job instance reference. */
String getJobId();
/** Job definition reference. */
String getJobDefinitionId();
/** Batch reference. */
String getBatchId();
/** The User who performed the operation */
String getUserId();
/** Timestamp of this change. */
Date getTimestamp();
/**
* The unique identifier of this operation.
*
* If an operation modifies multiple properties, multiple {@link UserOperationLogEntry} instances will be
* created with a common operationId. This allows grouping multiple entries which are part of a composite operation.
*/
String getOperationId();
/** External task reference. */
String getExternalTaskId();
/**
* Type of this operation, like create, assign, claim and so on.
*
* @see #OPERATION_TYPE_ASSIGN and other fields beginning with OPERATION_TYPE
*/
String getOperationType();
/**
* The type of the entity on which this operation was executed.
*
* @see #ENTITY_TYPE_TASK and other fields beginning with ENTITY_TYPE
*/
String getEntityType();
/** The property changed by this operation. */
String getProperty();
/** The original value of the property. */
String getOrgValue();
/** The new value of the property. */
String getNewValue();
/** The time the historic user operation log will be removed. */
Date getRemovalTime();
/** The category this entry is associated with */
String getCategory();
/** An arbitrary annotation set by a user for auditing reasons */
String getAnnotation();
/**
* The id of the tenant this user operation log belongs to. Can be null
* if the user operation log belongs to no single tenant.
*/
String getTenantId();
}