/*
 * 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 org.apache.myfaces.orchestra.viewController.annotations;

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Marks a method as needing to be invoked by the ViewController.
 * <p>
 * This method will be invoked before any "action" callbacks related to buttons,
 * links, etc. are invoked on backing beans for the current request.
 * <p>
 * For JSF, there is an exception: for command components marked as "immediate",
 * the associated action method is invoked before this callback occurs. If that
 * method then performs navigation then this callback will not occur at all.
 * <p>
 * Note also that for JSF, if validation failures occur then this callback will
 * not be invoked (as actions are skipped).  
 * <p>
 * This annotation will be ignored unless the class is also marked with the
 * ViewController annotation.
 * <p>
 * See also: org.apache.myfaces.orchestra.viewController.ViewController
 */
@Target(value = {ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
public @interface PreProcess
{
}
