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 * Cancels a document creation in UI (equivalent to clicking on the 'cancel' button on a document creation form).
029 *
030 * @since 5.4.2
031 */
032@Operation(id = CancelCreateDocumentInUI.ID, category = Constants.CAT_UI, requires = Constants.SEAM_CONTEXT, label = "Cancel Document Creation in UI", description = "Cancels a document creation in UI, "
033        + "as if user was hitting the 'Cancel' button on a the document creation form. "
034        + "It returns the parent document, that would have been the created document container.", aliases = { "Seam.CancelCreateDocumentInUI" })
035public class CancelCreateDocumentInUI {
036
037    public static final String ID = "Navigation.GoBack";
038
039    @Context
040    protected OperationContext ctx;
041
042    @OperationMethod
043    public DocumentModel run() {
044        ctx.put(SeamOperation.OUTCOME, OperationHelper.getNavigationContext().goBack());
045        return OperationHelper.getNavigationContext().getCurrentDocument();
046    }
047
048}