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 * Pop a document from the context stack and restore the input from the popped document. If on the top of the stack
035 * there is no document an exception is thrown This operation contains dynamic logic so it should be handled in a
036 * special way by the UI tools to validate the chain (a Pop operation can succeed only if the last push operation has
037 * the same type as the pop)
038 *
039 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
040 */
041@Operation(id = PopDocumentList.ID, category = Constants.CAT_EXECUTION_STACK, label = "Pop Document List", description = "Restore the last saved input document list in the context input stack", aliases = { "Document.PopList" })
042public class PopDocumentList {
043
044    public static final String ID = "Context.PopDocumentList";
045
046    @Context
047    protected OperationContext ctx;
048
049    @OperationMethod
050    public DocumentModelList run() throws OperationException {
051        Object obj = ctx.pop(Constants.O_DOCUMENTS);
052        if (obj instanceof DocumentModelList) {
053            return (DocumentModelList) obj;
054        } else if (obj instanceof DocumentRefList) {
055            CoreSession session = ctx.getCoreSession();
056            DocumentRefList refs = (DocumentRefList) obj;
057            DocumentModelListImpl list = new DocumentModelListImpl((int) refs.totalSize());
058            for (DocumentRef ref : refs) {
059                list.add(session.getDocument(ref));
060            }
061            // FIXME: variable list is never used!
062        }
063        throw new OperationException(
064                "Illegal state error for pop document operation. The context stack doesn't contains a document list on its top");
065    }
066
067}