/*
 * 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.itemApproval;

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

    // List of Integers corresponding to individual stages
    public static final String APPROVAL_STAGES = "approvalStages";            // List<Integer>

	// Variable holding current stage number. It is generated by the loop, so it is not a process-root variable
	// Therefore it has a name different from "root" stageNumber variable.
	public static final String STAGE_NUMBER_LOCAL = "stageNumberLocal";			// Integer

	// How the user task (work item) should be named.
    public static final String APPROVAL_TASK_NAME = "approvalTaskName";         // of type String

    // Whether we have to stop approving at the current stage (means the approval was rejected at this stage).
    public static final String LOOP_STAGES_STOP = "loopStages_stop";            // Boolean

    // Approvers that should be consulted within this stage.
    public static final String APPROVERS_IN_STAGE = "approversInStage";         // List<LightweightObjectRef>

    // Current approver (one of APPROVERS_IN_STAGE)
    public static final String APPROVER_REF = "approverRef";         // LightweightObjectRef

    // Oid of the approver if approverRef is a user (in that case, the task is assigned directly to the user)
    public static final String ASSIGNEE = "assignee";

    // type:oid of the abstract role if approverRef is an abstract role (in that case, it is used as a candidate group)
    // syntax was changed in midPoint 3.6 (e.g. from role:oid to RoleType:oid)
    public static final String CANDIDATE_GROUPS = "candidateGroups";

    // Whether we have to stop evaluating current stage (e.g. because strategy was 'firstDecides' and the first person decided (approved or rejected).
    public static final String LOOP_APPROVERS_IN_STAGE_STOP = "loopApproversInStage_stop";  // Boolean
}