001/*
002 * (C) Copyright 2006-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 */
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.core.annotations.Param;
027import org.nuxeo.ecm.automation.jsf.OperationHelper;
028import org.nuxeo.ecm.core.api.DocumentModel;
029
030/**
031 * @author <a href="mailto:td@nuxeo.com">Thierry Delprat</a>
032 */
033@Operation(id = Navigate.ID, category = Constants.CAT_UI, requires = Constants.SEAM_CONTEXT, label = "Navigate to Document", description = "Navigate to the input document. The outcome of the UI action will be stored in the operation chain context as the 'Outcome' variable. Returns back the document.", aliases = {
034        "WebUI.NavigateTo" })
035public class Navigate {
036
037    public static final String ID = "Seam.NavigateTo";
038
039    @Context
040    protected OperationContext ctx;
041
042    @Param(name = "view", required = false)
043    protected String view;
044
045    @OperationMethod
046    public DocumentModel run(DocumentModel doc) {
047        String outcome = null;
048
049        if (view == null) {
050            outcome = OperationHelper.getNavigationContext().navigateToDocument(doc);
051        } else {
052            outcome = OperationHelper.getNavigationContext().navigateToDocument(doc, view);
053        }
054
055        ctx.put(SeamOperation.OUTCOME, outcome);
056
057        return doc;
058    }
059}