javax.faces.flow.builder.FlowCallBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

There is a newer version: 4.1.1

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.faces.flow.builder;

import javax.el.ValueExpression;

/**
 * Create a flow call node in the current {@link javax.faces.flow.Flow}.
 * @since 2.2
 */
public abstract class FlowCallBuilder implements NodeBuilder {
    
    /**
     * Define the flow reference of the called flow.
     * 
     * @param flowDocumentId the document id of the called flow.  May not be {@code null}, 
     * but may be the empty string.
     * @param flowId the id of the called flow.  May not be {@code null}
     * @throws NullPointerException if any of the parameters are {@code null}
     * @since 2.2
     *
     * @return the builder instance
     */
    public abstract FlowCallBuilder flowReference(String flowDocumentId, 
                                                  String flowId);
    
    /**
     * Define an outbound parameter for the flow call.
     * 
     * @param name the name of the parameter
     * @param value the value of the parameter
     * @throws NullPointerException if any of the parameters are {@code null}
     * @since 2.2
     *
     * @return the builder instance
     */
    public abstract FlowCallBuilder outboundParameter(String name, ValueExpression value);
        
    /**
     * Define an outbound parameter for the flow call.
     * 
     * @param name the name of the parameter
     * @param value the value of the parameter
     * @throws NullPointerException if any of the parameters are {@code null}
     * @since 2.2
     *
     * @return the builder instance
     */
    public abstract FlowCallBuilder outboundParameter(String name, String value);

    @Override
    public abstract FlowCallBuilder markAsStartNode();
    
}