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.OperationException;
023import org.nuxeo.ecm.automation.core.Constants;
024import org.nuxeo.ecm.automation.core.annotations.Context;
025import org.nuxeo.ecm.automation.core.annotations.Operation;
026import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
027import org.nuxeo.ecm.automation.core.annotations.Param;
028import org.nuxeo.ecm.core.api.CoreSession;
029import org.nuxeo.ecm.core.api.DocumentModelList;
030import org.nuxeo.ecm.core.api.DocumentRef;
031import org.nuxeo.ecm.core.api.DocumentRefList;
032import org.nuxeo.ecm.core.api.impl.DocumentModelListImpl;
033
034/**
035 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
036 */
037@Operation(id = RestoreDocumentsInput.ID, category = Constants.CAT_EXECUTION, label = "Restore Documents Input", description = "Restore the document list input from a context variable given its name. Return the document list.")
038public class RestoreDocumentsInput {
039
040    public static final String ID = "Context.RestoreDocumentsInput";
041
042    @Context
043    protected OperationContext ctx;
044
045    @Param(name = "name")
046    protected String name;
047
048    @OperationMethod
049    public DocumentModelList run() throws OperationException {
050        Object obj = ctx.get(name);
051        if (obj instanceof DocumentModelList) {
052            return (DocumentModelList) obj;
053        } else if (obj instanceof DocumentRefList) {
054            CoreSession session = ctx.getCoreSession();
055            DocumentRefList refs = (DocumentRefList) obj;
056            DocumentModelListImpl list = new DocumentModelListImpl((int) refs.totalSize());
057            for (DocumentRef ref : refs) {
058                list.add(session.getDocument(ref));
059            }
060            // FIXME: variable list is never used!
061        }
062        throw new OperationException(
063                "Illegal state error for restore documents operation. The context stack doesn't contains a documents variable with the name "
064                        + name);
065    }
066
067}