001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 */
019package org.nuxeo.ecm.platform.routing.api.operation;
020
021import org.nuxeo.ecm.automation.OperationContext;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.annotations.Param;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.platform.routing.api.DocumentRouteStep;
028import org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants;
029import org.nuxeo.ecm.platform.routing.api.helper.ConditionalFolderUpdateRunner;
030
031/***
032 * Set the position of the child to be run once the step with the given id it's finished.
033 *
034 * @since 5.5
035 * @deprecated since 5.9.2 - Use only routes of type 'graph'
036 */
037@Deprecated
038@Operation(id = SetNextStepOnConditionalFolderOperation.ID, category = DocumentRoutingConstants.OPERATION_CATEGORY_ROUTING_NAME, label = "Choose branch", description = "Update branch to be executed ", addToStudio = false)
039public class SetNextStepOnConditionalFolderOperation {
040
041    public static final String ID = "Update.NextStep.ConditionalFolder";
042
043    @Param(name = "nextStepPos", required = true)
044    protected String nextStepPos;
045
046    @Context
047    protected OperationContext context;
048
049    @Context
050    protected CoreSession session;
051
052    @OperationMethod
053    public void setStepToBeExcutedNext() {
054        DocumentRouteStep step = (DocumentRouteStep) context.get(DocumentRoutingConstants.OPERATION_STEP_DOCUMENT_KEY);
055        ConditionalFolderUpdateRunner condFolderUpdater = new ConditionalFolderUpdateRunner(step.getDocument().getId());
056        condFolderUpdater.setStepToBeExecutedNext(session, nextStepPos);
057    }
058}