001/*
002 * (C) Copyright 2006-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 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core.operations;
020
021import org.nuxeo.ecm.automation.OperationContext;
022import org.nuxeo.ecm.automation.core.Constants;
023import org.nuxeo.ecm.automation.core.annotations.Context;
024import org.nuxeo.ecm.automation.core.annotations.Operation;
025import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
026import org.nuxeo.ecm.automation.core.annotations.Param;
027
028/**
029 * Generic fetch document operation that can be used on any context that has a document as the input. This operation
030 * takes the context input and it returns it as a document. If the input is not a document, an exception is thrown.
031 *
032 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
033 */
034@Operation(id = SetVar.ID, category = Constants.CAT_EXECUTION, label = "Set Context Variable", description = "Set a context variable given a name and the value. 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.")
035public class SetVar {
036
037    public static final String ID = "Context.SetVar";
038
039    @Context
040    protected OperationContext ctx;
041
042    @Param(name = "name")
043    protected String name;
044
045    @Param(name = "value", required = false)
046    protected Object value;
047
048    @OperationMethod
049    public void run() {
050        ctx.put(name, value);
051    }
052
053}