001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Anahide Tchertchian
016 */
017package org.nuxeo.ecm.automation.jsf.operations;
018
019import org.nuxeo.ecm.automation.OperationContext;
020import org.nuxeo.ecm.automation.core.Constants;
021import org.nuxeo.ecm.automation.core.annotations.Context;
022import org.nuxeo.ecm.automation.core.annotations.Operation;
023import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
024import org.nuxeo.ecm.automation.jsf.OperationHelper;
025import org.nuxeo.ecm.core.api.DocumentModel;
026
027/**
028 * Saves a document (equivalent to clicking on the 'save' button on a document edition form).
029 *
030 * @since 5.4.2
031 */
032@Operation(id = SaveDocumentInUI.ID, category = Constants.CAT_UI, requires = Constants.SEAM_CONTEXT, label = "Save Document in UI", description = "Saves a document in UI, "
033        + "as if user was hitting the 'Save' button on a the document edition form. "
034        + "It assumes that the contextual 'currentDocument' document from the Seam context has been updated "
035        + "to hold the new properties. It will navigate to the edited document context, "
036        + "set its view as outcome, and return it.")
037public class SaveDocumentInUI {
038
039    public static final String ID = "Seam.SaveDocumentInUI";
040
041    @Context
042    protected OperationContext ctx;
043
044    @OperationMethod
045    public DocumentModel run() {
046        ctx.put(SeamOperation.OUTCOME, OperationHelper.getDocumentActions().updateCurrentDocument());
047        return OperationHelper.getNavigationContext().getCurrentDocument();
048    }
049
050}