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.orchestra.viewController.annotations;
21
22 import java.lang.annotation.Target;
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26
27 /**
28 * Marks a method as needing to be invoked by the ViewController.
29 * <p>
30 * This method will be invoked before any "action" callbacks related to buttons,
31 * links, etc. are invoked on backing beans for the current request.
32 * <p>
33 * For JSF, there is an exception: for command components marked as "immediate",
34 * the associated action method is invoked before this callback occurs. If that
35 * method then performs navigation then this callback will not occur at all.
36 * <p>
37 * Note also that for JSF, if validation failures occur then this callback will
38 * not be invoked (as actions are skipped).
39 * <p>
40 * This annotation will be ignored unless the class is also marked with the
41 * ViewController annotation.
42 * <p>
43 * See also: org.apache.myfaces.orchestra.viewController.ViewController
44 */
45 @Target(value = {ElementType.METHOD})
46 @Retention(value = RetentionPolicy.RUNTIME)
47 public @interface PreProcess
48 {
49 }