001/*
002 * (C) Copyright 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 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.automation.jsf.operations;
020
021import org.nuxeo.ecm.automation.OperationContext;
022import org.nuxeo.ecm.automation.core.Constants;
023import org.nuxeo.ecm.automation.core.annotations.Context;
024import org.nuxeo.ecm.automation.core.annotations.Operation;
025import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
026import org.nuxeo.ecm.automation.jsf.OperationHelper;
027import org.nuxeo.ecm.core.api.DocumentModel;
028
029/**
030 * Cancels a document creation in UI (equivalent to clicking on the 'cancel' button on a document creation form).
031 *
032 * @since 5.4.2
033 */
034@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, "
035        + "as if user was hitting the 'Cancel' button on a the document creation form. "
036        + "It returns the parent document, that would have been the created document container.", aliases = { "Seam.CancelCreateDocumentInUI" })
037public class CancelCreateDocumentInUI {
038
039    public static final String ID = "Navigation.GoBack";
040
041    @Context
042    protected OperationContext ctx;
043
044    @OperationMethod
045    public DocumentModel run() {
046        ctx.put(SeamOperation.OUTCOME, OperationHelper.getNavigationContext().goBack());
047        return OperationHelper.getNavigationContext().getCurrentDocument();
048    }
049
050}