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.stack;
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.core.api.CoreSession;
028import org.nuxeo.ecm.core.api.DocumentModelList;
029import org.nuxeo.ecm.core.api.DocumentRef;
030import org.nuxeo.ecm.core.api.DocumentRefList;
031import org.nuxeo.ecm.core.api.impl.DocumentModelListImpl;
032
033/**
034 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
035 */
036@Operation(id = PullDocumentList.ID, category = Constants.CAT_EXECUTION_STACK, label = "Pull Document List", description = "Restore the first saved input document list in the context input stack", aliases = { "Document.PullList" })
037public class PullDocumentList {
038
039    public static final String ID = "Context.PullDocumentList";
040
041    @Context
042    protected OperationContext ctx;
043
044    @OperationMethod
045    public DocumentModelList run() throws OperationException {
046        Object obj = ctx.pull(Constants.O_DOCUMENTS);
047        if (obj instanceof DocumentModelList) {
048            return (DocumentModelList) obj;
049        } else if (obj instanceof DocumentRefList) {
050            CoreSession session = ctx.getCoreSession();
051            DocumentRefList refs = (DocumentRefList) obj;
052            DocumentModelListImpl list = new DocumentModelListImpl((int) refs.totalSize());
053            for (DocumentRef ref : refs) {
054                list.add(session.getDocument(ref));
055            }
056            // FIXME: variable list is never used!
057        }
058        throw new OperationException(
059                "Illegal state error for pull document operation. The context stack doesn't contains a document list on its bottom");
060    }
061
062}