1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.myfaces.tobago.internal.lifecycle;
21
22 import javax.faces.context.FacesContext;
23 import javax.faces.event.PhaseId;
24
25 /**
26 * Implements the PhaseExecutor for a lifecycle
27 */
28 interface PhaseExecutor {
29
30 /**
31 * Executes a phase of the JavaServer(tm) Faces lifecycle, like UpdateModelValues.
32 * The <code>execute</code> method is called by the lifecylce implementation's private
33 * <code>executePhase</code>.
34 *
35 * @param facesContext The <code>FacesContext</code> for the current request we are processing
36 * @return <code>true</code> if execution should be stopped
37 */
38 boolean execute(FacesContext facesContext);
39
40 /**
41 * Returns the <code>PhaseId</code> for which the implemented executor is invoked
42 *
43 * @return
44 */
45 PhaseId getPhase();
46 }