001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 */
011
012package org.nuxeo.ecm.automation.jsf.operations;
013
014import org.nuxeo.ecm.automation.OperationContext;
015import org.nuxeo.ecm.automation.core.Constants;
016import org.nuxeo.ecm.automation.core.annotations.Context;
017import org.nuxeo.ecm.automation.core.annotations.Operation;
018import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
019import org.nuxeo.ecm.automation.core.annotations.Param;
020import org.nuxeo.ecm.automation.jsf.OperationHelper;
021import org.nuxeo.ecm.core.api.DocumentModel;
022
023/**
024 * @author <a href="mailto:td@nuxeo.com">Thierry Delprat</a>
025 */
026@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 = { "Seam.NavigateTo" })
027public class Navigate {
028
029    public static final String ID = "WebUI.NavigateTo";
030
031    @Context
032    protected OperationContext ctx;
033
034    @Param(name = "view", required = false)
035    protected String view;
036
037    @OperationMethod
038    public DocumentModel run(DocumentModel doc) {
039        String outcome = null;
040
041        if (view == null) {
042            outcome = OperationHelper.getNavigationContext().navigateToDocument(doc);
043        } else {
044            outcome = OperationHelper.getNavigationContext().navigateToDocument(doc, view);
045        }
046
047        ctx.put(SeamOperation.OUTCOME, outcome);
048
049        return doc;
050    }
051}