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.core.api.DocumentModel;
027import org.nuxeo.ecm.core.api.DocumentModelList;
028
029/**
030 * Generic fetch document operation that can be used on any context that has a document as the input. This operation is
031 * taking the context input and it is returning it as a document If the input is not a document an exception is thrown
032 *
033 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
034 */
035@Operation(id = FetchContextDocument.ID, category = Constants.CAT_FETCH, label = "Context Document(s)", description = "Fetch the input of the context as a document or list of documents. The document will become the input for the next operation.")
036public class FetchContextDocument {
037
038    public static final String ID = "Context.FetchDocument";
039
040    @Context
041    protected OperationContext ctx;
042
043    @OperationMethod
044    public DocumentModel run(DocumentModel doc) {
045        return doc;
046    }
047
048    @OperationMethod
049    public DocumentModelList run(DocumentModelList docs) {
050        return docs;
051    }
052
053}