001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.uif.lifecycle.finalize;
017
018import org.kuali.rice.krad.uif.lifecycle.FinalizeComponentPhase;
019import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle;
020import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
021import org.kuali.rice.krad.uif.util.LifecycleElement;
022
023/**
024 * Perform custom finalize behavior for the component defined by the helper.
025 * 
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public class HelperCustomFinalizeTask extends ViewLifecycleTaskBase<LifecycleElement> {
029
030    /**
031     * Constructor.
032     * 
033     * @param phase The finalize phase for the component.
034     */
035    public HelperCustomFinalizeTask() {
036        super(LifecycleElement.class);
037    }
038
039    /**
040     * {@inheritDoc}
041     */
042    @Override
043    public FinalizeComponentPhase getElementState() {
044        return (FinalizeComponentPhase) super.getElementState();
045    }
046
047    /**
048     * {@inheritDoc}
049     */
050    @Override
051    protected void performLifecycleTask() {
052        // invoke service override hook
053        ViewLifecycle.getHelper().performCustomFinalize(getElementState().getElement(),
054                ViewLifecycle.getModel(),
055                getElementState().getParent());
056    }
057
058}