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;
017
018import org.kuali.rice.krad.uif.util.LifecycleElement;
019import org.kuali.rice.krad.uif.view.View;
020
021/**
022 * Handles delivery of per-node parse state for path-based view lifecycle algorithms.
023 * 
024 * <p>
025 * The interface is used for assigning the path property value during the {@link View}'s pre-process
026 * phase.
027 * </p>
028 * 
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 */
031public interface LifecycleElementState {
032    
033    /**
034     * Gets the view lifecycle phase constant that corresponds to this phase processing task.
035     * 
036     * @return view lifecycle phase constant corresponding to this phase
037     * @see org.kuali.rice.krad.uif.UifConstants.ViewPhases
038     */
039    String getViewPhase();
040
041    /**
042     * Gets the path relative to the view.
043     * 
044     * @return path relative the the view
045     */
046    String getViewPath();
047    
048    /**
049     * Gets the element this lifecycle phase is responsible for processing.
050     * 
051     * @return element this lifecycle phase is responsible for processing
052     */
053    LifecycleElement getElement();
054
055    /**
056     * Gets the path relative the predecessor phase's component.
057     * 
058     * @return path relative the predecessor phase's component
059     */
060    String getParentPath();
061
062    /**
063     * Gets the depth of the element in the lifecycle tree.
064     * 
065     * @return The depth of the element in the lifecycle tree.
066     */
067    int getDepth();
068
069}