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.core.Constants;
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 * @since 5.4.2
029 */
030@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. "
031        + "The changeable document is used on creation forms.")
032public class GetChangeableDocument {
033
034    public static final String ID = "Seam.GetChangeableDocument";
035
036    @OperationMethod
037    public DocumentModel run() {
038        return OperationHelper.getNavigationContext().getChangeableDocument();
039    }
040
041}