View Javadoc
1   /**
2    * Copyright 2005-2016 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.finalize;
17  
18  import org.kuali.rice.krad.uif.lifecycle.FinalizeComponentPhase;
19  import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle;
20  import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
21  import org.kuali.rice.krad.uif.util.LifecycleElement;
22  
23  /**
24   * Perform custom finalize behavior for the component defined by the helper.
25   * 
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public class HelperCustomFinalizeTask extends ViewLifecycleTaskBase<LifecycleElement> {
29  
30      /**
31       * Constructor.
32       * 
33       * @param phase The finalize phase for the component.
34       */
35      public HelperCustomFinalizeTask() {
36          super(LifecycleElement.class);
37      }
38  
39      /**
40       * {@inheritDoc}
41       */
42      @Override
43      public FinalizeComponentPhase getElementState() {
44          return (FinalizeComponentPhase) super.getElementState();
45      }
46  
47      /**
48       * {@inheritDoc}
49       */
50      @Override
51      protected void performLifecycleTask() {
52          // invoke service override hook
53          ViewLifecycle.getHelper().performCustomFinalize(getElementState().getElement(),
54                  ViewLifecycle.getModel(),
55                  getElementState().getParent());
56      }
57  
58  }