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.core.Constants;
016import org.nuxeo.ecm.automation.core.annotations.Context;
017import org.nuxeo.ecm.automation.core.annotations.Operation;
018import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
019import org.nuxeo.ecm.core.api.DocumentModelList;
020import org.nuxeo.ecm.core.api.DocumentRefList;
021
022/**
023 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
024 */
025@Operation(id = PushDocumentList.ID, category = Constants.CAT_EXECUTION_STACK, label = "Push Document List", description = "Push the input document list on the context stack. The document list can be restored later as the input using the corrresponding pop operation. Returns the input document list.", aliases = { "Document.PushList" })
026public class PushDocumentList {
027
028    public static final String ID = "Context.PushDocumentList";
029
030    @Context
031    protected OperationContext ctx;
032
033    @OperationMethod
034    public DocumentModelList run(DocumentModelList doc) {
035        ctx.push(Constants.O_DOCUMENTS, doc);
036        return doc;
037    }
038
039    @OperationMethod
040    public DocumentRefList run(DocumentRefList doc) {
041        ctx.push(Constants.O_DOCUMENTS, doc);
042        return doc;
043    }
044
045}