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 = { "Seam.NavigateTo" }) 034public class Navigate { 035 036 public static final String ID = "WebUI.NavigateTo"; 037 038 @Context 039 protected OperationContext ctx; 040 041 @Param(name = "view", required = false) 042 protected String view; 043 044 @OperationMethod 045 public DocumentModel run(DocumentModel doc) { 046 String outcome = null; 047 048 if (view == null) { 049 outcome = OperationHelper.getNavigationContext().navigateToDocument(doc); 050 } else { 051 outcome = OperationHelper.getNavigationContext().navigateToDocument(doc, view); 052 } 053 054 ctx.put(SeamOperation.OUTCOME, outcome); 055 056 return doc; 057 } 058}