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.DocumentModel;
028import org.nuxeo.ecm.core.api.DocumentRef;
029
030/**
031 * Pop a document from the context stack and restore the input from the poped document. If on the top of the stack there
032 * is no document an exception is thrown This operation contains dynamic logic so it should be handled in a special way
033 * by the UI tools to validate the chain (a Pop operation can succeed only if the last push operation has the same type
034 * as the pop)
035 *
036 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
037 */
038@Operation(id = PopDocument.ID, category = Constants.CAT_EXECUTION_STACK, label = "Pop Document", description = "Restore the last saved input document in the context input stack. This operation must be used only if a PUSH operation was previously made. Return the last <i>pushed</i> document.", aliases = { "Document.Pop" })
039public class PopDocument {
040
041    public static final String ID = "Context.PopDocument";
042
043    @Context
044    protected OperationContext ctx;
045
046    @OperationMethod
047    public DocumentModel run() throws OperationException {
048        Object obj = ctx.pop(Constants.O_DOCUMENT);
049        if (obj instanceof DocumentModel) {
050            return (DocumentModel) obj;
051        } else if (obj instanceof DocumentRef) {
052            return ctx.getCoreSession().getDocument((DocumentRef) obj);
053        }
054        throw new OperationException(
055                "Illegal state error for pop document operation. The context stack doesn't contains a document on its top");
056    }
057
058}