1 /**
2 * Copyright 2005-2014 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.UifConstants;
19 import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle.LifecycleEvent;
20
21 /**
22 * Lifecycle phase processing task for initializing a component.
23 *
24 * <p>
25 * During the initialize phase each component of the tree is invoked to setup state based on the
26 * configuration and request options.
27 * </p>
28 *
29 * <p>
30 * The initialize phase is only called once per <code>View</code> lifecycle
31 * </p>
32 *
33 * <p>
34 * Note the <code>View</code> instance also contains the context Map that was created based on the
35 * parameters sent to the view service
36 * </p>
37 *
38 * @author Kuali Rice Team (rice.collab@kuali.org)
39 */
40 public class InitializeComponentPhase extends ViewLifecyclePhaseBase {
41
42 /**
43 * {@inheritDoc}
44 *
45 * @return UifConstants.ViewPhases.INITIALIZE
46 */
47 @Override
48 public String getViewPhase() {
49 return UifConstants.ViewPhases.INITIALIZE;
50 }
51
52 /**
53 * {@inheritDoc}
54 * return UifConstants.ViewStatus.CREATED
55 */
56 @Override
57 public String getStartViewStatus() {
58 return UifConstants.ViewStatus.CREATED;
59 }
60
61 /**
62 * {@inheritDoc}
63 *
64 * @return UifConstants.ViewStatus.INITIALIZED
65 */
66 @Override
67 public String getEndViewStatus() {
68 return UifConstants.ViewStatus.INITIALIZED;
69 }
70
71 /**
72 * {@inheritDoc}
73 */
74 @Override
75 public LifecycleEvent getEventToNotify() {
76 return null;
77 }
78
79 }