/*

  * $Id: ViewPreparer.java 1310865 2012-04-07 21:01:22Z nlebas $

  *

  * 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 org.apache.tiles.preparer;

 import org.apache.tiles.AttributeContext;

 import org.apache.tiles.request.Request;

 /**

  * <p>

  * Executed prior to rendering a view.

  * </p>

  *

  * <p>

  * A view preparer is typically used to provide last minute

  * translations of the data within the attribute context.

  * A preparer is not intended to replace the controller within an

  * MVC architecture.

  * </p>

  *

  * See

  * <ul>

  * <li>&lt;insert&gt;</li>

  * <li>&lt;definition&gt;</li>

  * </ul>>

  *

  * @version $Rev: 1310865 $ $Date: 2012-04-08 07:01:22 +1000 (Sun, 08 Apr 2012) $

  */

 public interface ViewPreparer {

     /**

      * Method associated to a tile and called immediately before the tile

      * is included.

      *

      * @param tilesContext     Current tiles application context.

      * @param attributeContext Current tile context.

      * @throws PreparerException If something goes wrong during execution.

      */

     void execute(Request tilesContext,

         AttributeContext attributeContext);

 }