001/*
002 * (C) Copyright 2012 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 *     mcedica
018 */
019package org.nuxeo.ecm.platform.routing.api.operation;
020
021import java.io.Serializable;
022import java.util.Map;
023
024import org.nuxeo.ecm.automation.OperationContext;
025import org.nuxeo.ecm.automation.core.Constants;
026import org.nuxeo.ecm.automation.core.annotations.Context;
027import org.nuxeo.ecm.automation.core.annotations.Operation;
028import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
029import org.nuxeo.ecm.automation.core.annotations.Param;
030
031/**
032 * Generic fetch document operation that can be used on any context that has a document as the input. This operation
033 * takes the context input and it returns it as a document. If the input is not a document, an exception is thrown.
034 */
035@Operation(id = SetWorkflowNodeVar.ID, category = Constants.CAT_WORKFLOW, requires = Constants.WORKFLOW_CONTEXT, label = "Set Node Variable", description = "Set a workflow node variable given a name and the value in the context of a running workflow. To compute the value at runtime from the current context you should use an EL expression as the value. This operation works on any input type and return back the input as the output.", aliases = { "Context.SetWorkflowNodeVar" })
036public class SetWorkflowNodeVar {
037
038    public static final String ID = "Workflow.SetNodeVariable";
039
040    @Context
041    protected OperationContext ctx;
042
043    @Param(name = "name")
044    protected String name;
045
046    @Param(name = "value", required = false)
047    protected Object value;
048
049    @SuppressWarnings("unchecked")
050    @OperationMethod
051    public void run() {
052        if (ctx.get(Constants.VAR_WORKFLOW_NODE) != null) {
053            ((Map<String, Serializable>) ctx.get(Constants.VAR_WORKFLOW_NODE)).put(name, (Serializable) value);
054        }
055    }
056}