001/*
002 * (C) Copyright 2010 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 *     Alexandre Russel
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.platform.routing.api.DocumentRouteStep;
026import org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants;
027
028/**
029 * An operation that set the step to the done state.
030 *
031 * @author <a href="mailto:arussel@nuxeo.com">Alexandre Russel</a>
032 * @deprecated since 5.9.2 - Use only routes of type 'graph'
033 */
034@Deprecated
035@Operation(id = StepDoneOperation.ID, category = DocumentRoutingConstants.OPERATION_CATEGORY_ROUTING_NAME, label = "Set Step Done", description = "Set the step as done.", addToStudio = false)
036public class StepDoneOperation {
037    public final static String ID = "Document.Routing.Step.Done";
038
039    @Context
040    protected OperationContext context;
041
042    @OperationMethod
043    public void setStepDone() {
044        DocumentRouteStep step = (DocumentRouteStep) context.get(DocumentRoutingConstants.OPERATION_STEP_DOCUMENT_KEY);
045        step.setDone(context.getCoreSession());
046    }
047}