001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 *     bstefanescu
011 */
012package org.nuxeo.ecm.automation.core.operations.stack;
013
014import org.nuxeo.ecm.automation.OperationContext;
015import org.nuxeo.ecm.automation.OperationException;
016import org.nuxeo.ecm.automation.core.Constants;
017import org.nuxeo.ecm.automation.core.annotations.Context;
018import org.nuxeo.ecm.automation.core.annotations.Operation;
019import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
020import org.nuxeo.ecm.core.api.DocumentModel;
021import org.nuxeo.ecm.core.api.DocumentRef;
022
023/**
024 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
025 */
026@Operation(id = PullDocument.ID, category = Constants.CAT_EXECUTION_STACK, label = "Pull Document", description = "Restore the first saved input document in the context input stack. This operation must be used only if a PUSH operation was previously made. Return the first <i>pushed</i> document.", aliases = { "Document.Pull" })
027public class PullDocument {
028
029    public static final String ID = "Context.PullDocument";
030
031    @Context
032    protected OperationContext ctx;
033
034    @OperationMethod
035    public DocumentModel run() throws OperationException {
036        Object obj = ctx.pull(Constants.O_DOCUMENT);
037        if (obj instanceof DocumentModel) {
038            return (DocumentModel) obj;
039        } else if (obj instanceof DocumentRef) {
040            return ctx.getCoreSession().getDocument((DocumentRef) obj);
041        }
042        throw new OperationException(
043                "Illegal state error for pull document operation. The context stack doesn't contains a document on its bottom");
044    }
045
046}