/*
 * Copyright (c) 2010-2013 Evolveum
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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 com.evolveum.midpoint.wf.impl.processes.common;

/**
 * @author mederly
 */
public class CommonProcessVariableNames {

    // [String]
    // Process instance name, e.g. "Approving adding Webmaster to JoeDoe".
	// Used for diagnostic purposes.
    public static final String VARIABLE_PROCESS_INSTANCE_NAME = "processInstanceName";

	// [java.util.Date]
    // When the process instance was started.
    public static final String VARIABLE_START_TIME = "startTime";

	// [String]
    // OID of task related to the process instance.
    public static final String VARIABLE_MIDPOINT_TASK_OID = "midPointTaskOid";

	// [String]
    // Java class name of the change processor (the same as wf:changeProcessor task property)
    public static final String VARIABLE_CHANGE_PROCESSOR = "changeProcessor";

	// [LightweightObjectRef]
    // Requester - OID + name + perhaps additional information
    public static final String VARIABLE_REQUESTER_REF = "requesterRef";

	// [LightweightObjectRef]
	// Object of the operation - if can be specified like this
	public static final String VARIABLE_OBJECT_REF = "objectRef";

	// [LightweightObjectRef]
	// Target of the operation - if any
	public static final String VARIABLE_TARGET_REF = "targetRef";

	// [Boolean]
    // A signal that the process instance is being stopped. Used e.g. to suppress propagation of exceptions
    // occurring in the process instance end listener.
    public static final String VARIABLE_PROCESS_INSTANCE_IS_STOPPING = "processInstanceIsStopping";

	// [String]
    // Name of process interface bean (ProcessMidPointInterface implementation) that is related to this process
    public static final String VARIABLE_PROCESS_INTERFACE_BEAN_NAME = "processInterfaceBeanName";

	// [ActivitiUtil]
	// Object that provides various utility methods for use in processes, e.g. getApprover(RoleType r).
	public static final String VARIABLE_UTIL = "util";

	// [String]
	// Outcome of a work item (URI).
	public static final String FORM_FIELD_OUTCOME = "[H]outcome";

	// [String]
	// Comment related to that decision - set by user task (form).
	// this value is put into audit record, so its advisable to use this particular name
	public static final String FORM_FIELD_COMMENT = "comment";

	// [String]
	// EXPERIMENTAL
	public static final String FORM_FIELD_ADDITIONAL_DELTA = "objectDelta";

	// [serialized value of WorkItemEventCauseInformationType]
	public static final String VARIABLE_CAUSE = "cause";

	// URI of the work item outcome
	public static final String VARIABLE_OUTCOME = "outcome";

	// Stage number - if process can be conceptually divided into stages. Starts at 1.
	// Null if not applicable. [Integer]
	public static final String VARIABLE_STAGE_NUMBER = "stageNumber";

	// Total number of stages - if process can be conceptually divided into stages.
	// Null if not applicable. [Integer]
	public static final String VARIABLE_STAGE_COUNT = "stageCount";

	// Stage name - if process can be conceptually divided into stages.
	// Null if unknown or not applicable. [String]
	public static final String VARIABLE_STAGE_NAME = "stageName";

	// Stage displayName
	// Null if unknown or not applicable. [String]
	public static final String VARIABLE_STAGE_DISPLAY_NAME = "stageDisplayName";

	// Stage number - if process can be conceptually divided into stages. Starts at 0.
	// Null if not applicable. [Integer]
	public static final String VARIABLE_ESCALATION_LEVEL_NUMBER = "escalationLevelNumber";

	// Stage name - if process can be conceptually divided into stages.
	// Null if unknown or not applicable. [String]
	public static final String VARIABLE_ESCALATION_LEVEL_NAME = "escalationLevelName";

	// Stage displayName
	// Null if unknown or not applicable. [String]
	public static final String VARIABLE_ESCALATION_LEVEL_DISPLAY_NAME = "escalationLevelDisplayName";

	// Additional information (for approver) - generated by evaluating appropriate expression in stage definition - may be specific for each approver
	// [SafeSerializationContainer of List<InformationType>]
	public static final String ADDITIONAL_INFORMATION = "additionalInformation";

	// Original assignee, if any. [String]
	// Formatted as type:OID
	// (Note that assignee itself is formatted like this since 3.6)
	public static final String VARIABLE_ORIGINAL_ASSIGNEE = "originalAssignee";

	public static final String TYPE_NAME_SEPARATOR = ":";

	// Whether this work item was completed (instead of simply deleted)
	// [Boolean]
	public static final String VARIABLE_WORK_ITEM_WAS_COMPLETED = "workItemWasCompleted";

	// Who completed this work item (OID of the user)
	// [String]
	public static final String VARIABLE_WORK_ITEM_COMPLETED_BY = "workItemCompletedBy";

	// Identity link type to denote an assignee. MidPoint uses it (instead of assignee), because we need to have potentially
	// more than one assignee
	public static final String MIDPOINT_ASSIGNEE = "midpoint-assignee";
}