001/**
002 * Copyright 2005-2016 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.initialize;
017
018import org.kuali.rice.krad.datadictionary.Copyable;
019import org.kuali.rice.krad.uif.UifConstants;
020import org.kuali.rice.krad.uif.lifecycle.LifecycleElementState;
021import org.kuali.rice.krad.uif.lifecycle.ViewLifecycle;
022import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleTaskBase;
023import org.kuali.rice.krad.uif.util.LifecycleElement;
024
025/**
026 * Invokes {@link Copyable#preventModification()} on the lifecycle element.
027 * 
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030public class PrepareForCacheTask extends ViewLifecycleTaskBase<LifecycleElement> {
031
032    /**
033     * Creates an instance based on element state.
034     */
035    public PrepareForCacheTask() {
036        super(LifecycleElement.class);
037    }
038
039    /**
040     * {@inheritDoc}
041     */
042    @Override
043    protected void performLifecycleTask() {
044        LifecycleElementState elementState = getElementState();
045        LifecycleElement element = elementState.getElement();
046        String viewStatus = element.getViewStatus();
047        
048        element.setViewStatus(UifConstants.ViewStatus.CACHED);
049        if (!UifConstants.ViewStatus.CREATED.equals(viewStatus) && !UifConstants.ViewStatus.CACHED.equals(viewStatus)) {
050            ViewLifecycle.reportIllegalState("View status is "
051                    + viewStatus
052                    + " prior to caching "
053                    + getClass().getName()
054                    + " "
055                    + element.getId()
056                    + ", expected C or X");
057        }
058
059        viewStatus = UifConstants.ViewStatus.CACHED;
060    }
061
062}