1 /**
2 * Copyright 2005-2015 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.uif.lifecycle;
17
18 import org.kuali.rice.krad.uif.component.Component;
19 import org.kuali.rice.krad.uif.util.LifecycleElement;
20 import org.kuali.rice.krad.uif.util.LifecycleElement;
21 import org.kuali.rice.krad.uif.view.View;
22
23 import java.util.List;
24
25 /**
26 * Encapsulates the concept of creating {@link ViewLifecyclePhase} instances during a the view
27 * lifecycle build process.
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 * @see ViewLifecycleBuild
31 */
32 public interface ViewLifecyclePhaseBuilder {
33
34 /**
35 * Creates a lifecycle phase instance for the given view.
36 *
37 * @param view view instance the phase should be built for
38 * @param viewPhase View phase to build an instance for
39 * @return pre-process phase instance
40 * @see ViewLifecycle#getView()
41 */
42 ViewLifecyclePhase buildPhase(View view, String viewPhase, List<String> refreshPaths);
43
44 /**
45 * Creates a lifecycle phase instance for a specific component in the current lifecycle.
46 *
47 * @param viewPhase view phase to build an instance for
48 * @param element lifecycle element to build an instance for
49 * @param parent parent component
50 * @param parentPath path relative to the parent component referring to the lifecycle element
51 * @return phase instance
52 */
53 ViewLifecyclePhase buildPhase(String viewPhase, LifecycleElement element, Component parent, String parentPath,
54 List<String> refreshPaths);
55
56 }