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.core.Constants;
020import org.nuxeo.ecm.automation.core.annotations.Operation;
021import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
022import org.nuxeo.ecm.automation.jsf.OperationHelper;
023import org.nuxeo.ecm.core.api.DocumentModel;
024
025/**
026 * @since 5.4.2
027 */
028@Operation(id = GetChangeableDocument.ID, category = Constants.CAT_FETCH, requires = Constants.SEAM_CONTEXT, label = "UI Changeable Document", description = "Get the current changeable document from the UI context. "
029        + "The changeable document is used on creation forms.")
030public class GetChangeableDocument {
031
032    public static final String ID = "Seam.GetChangeableDocument";
033
034    @OperationMethod
035    public DocumentModel run() {
036        return OperationHelper.getNavigationContext().getChangeableDocument();
037    }
038
039}