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;
020
021/**
022 * Sets the outcome for JSF navigation.
023 *
024 * @author <a href="mailto:td@nuxeo.com">Thierry Delprat</a>
025 * @since 5.4.2
026 */
027@Operation(id = SetOutcome.ID, category = Constants.CAT_UI, requires = Constants.SEAM_CONTEXT, label = "Set JSF Outcome", description = "Set the 'Outcome' context variable that represent a JSF outcome string. This outcome can be used by the next operations that need an outcome. It preserves the current input (e.g returns back the same input).", aliases = { "Seam.SetOutcome" })
028public class SetOutcome {
029
030    public static final String ID = "WebUI.SetJSFOutcome";
031
032    @Context
033    protected OperationContext ctx;
034
035    @Param(name = "outcome")
036    protected String outcome;
037
038    @OperationMethod
039    public void run() {
040        ctx.put(SeamOperation.OUTCOME, outcome);
041    }
042
043}