jakarta.faces.flow.Flow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation

The public API classes of the Apache MyFaces CORE JSF-2.1 project

There is a newer version: 4.1.0-RC3

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package jakarta.faces.flow;

import java.util.List;
import java.util.Map;
import jakarta.faces.application.NavigationCase;
import jakarta.faces.lifecycle.ClientWindow;

/**
 *
 * @since 2.2
 */
public abstract class Flow
{
    
    public abstract String getClientWindowFlowId(ClientWindow curWindow);

    public abstract String getDefiningDocumentId();

    public abstract String getId();

    public abstract Map getInboundParameters();
    
    public abstract jakarta.el.MethodExpression getInitializer();
    
    public abstract jakarta.el.MethodExpression getFinalizer();
    
    public abstract FlowCallNode getFlowCall(Flow targetFlow);
    
    public abstract Map getFlowCalls();
    
    public abstract List getMethodCalls();
    
    public abstract FlowNode getNode(String nodeId);
    
    public abstract Map getReturns();
    
    public abstract Map getSwitches();
    
    public abstract List getViews();
    
    public abstract String getStartNodeId();
    
    public abstract java.util.Map> getNavigationCases();
    
}