core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.opensymphony.xwork2.interceptor;

import com.opensymphony.xwork2.ModelDriven;

/**
 * Adds the ability to set a model, probably retrieved from a given state.
 */
public interface ScopedModelDriven<T> extends ModelDriven<T> {

    /**
     * @param model sets the model
     */
    void setModel(T model);
    
    /**
     * Sets the key under which the model is stored
     * @param key The model key
     */
    void setScopeKey(String key);
    
    /**
     * @return the key under which the model is stored
     */
    String getScopeKey();
}