1 /*
2 * Copyright (c) 2011-2024 PrimeFaces Extensions
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22 package org.primefaces.extensions.util.visitcallback;
23
24 import javax.faces.component.UIComponent;
25 import javax.faces.component.visit.VisitResult;
26
27 /**
28 * Interface for all executor classes which are called by visit callbacks. It can be used from outside (see the showcase).
29 *
30 * @author Oleg Varaksin
31 * @version $Revision: 1.0 $
32 * @since 0.7
33 */
34 public interface VisitTaskExecutor {
35
36 /**
37 * Execute some task on the given component.
38 *
39 * @param component UIComponent
40 * @return VisitResult (ACCEPT, REJECT, COMPLETE)
41 */
42 VisitResult execute(UIComponent component);
43
44 /**
45 * Should the task on the given component be executed?
46 *
47 * @param component UIComponent
48 * @return boolean true - the task should be executed, false - otherwise
49 */
50 boolean shouldExecute(UIComponent component);
51 }