001/**
002 * Copyright 2005-2014 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
018/**
019 * Abstract base lifecycle processor implementation.
020 * 
021 * @author Kuali Rice Team (rice.collab@kuali.org)
022 */
023public abstract class ViewLifecycleProcessorBase implements ViewLifecycleProcessor {
024
025    /**
026     * The view lifecycle to be processed.
027     */
028    private final ViewLifecycle lifecycle;
029
030    /**
031     * Creates a new processor for a lifecycle.
032     * 
033     * @param lifecycle The lifecycle to process.
034     */
035    ViewLifecycleProcessorBase(ViewLifecycle lifecycle) {
036        this.lifecycle = lifecycle;
037    }
038
039    /**
040     * {@inheritDoc}
041     */
042    @Override
043    public ViewLifecycle getLifecycle() {
044        return lifecycle;
045    }
046
047    /**
048     * Reports a phase as active on the current thread.
049     * 
050     * <p>
051     * Since each {@link ViewLifecycle} instance is specific to a thread, only one phase may be
052     * active at a time.
053     * </p>
054     * 
055     * @param phase The phase to report as active, or null when the active phase has been
056     *        completed.
057     * @see #getActivePhase()
058     */
059    abstract void setActivePhase(ViewLifecyclePhase phase);
060
061}