/*
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (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.mozilla.org/MPL/>.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT
 * WARRANTY OF ANY KIND, either express or implied. See the License for the specific
 * language governing rights and limitations under the License.
 * 
 * The Original Code is the Venice Web Communities System.
 * 
 * The Initial Developer of the Original Code is Eric J. Bowersox <erbo@silcom.com>,
 * for Silverwrist Design Studios.  Portions created by Eric J. Bowersox are
 * Copyright (C) 2002-03 Eric J. Bowersox/Silverwrist Design Studios.  All Rights Reserved.
 * 
 * Contributor(s): 
 */
package com.silverwrist.dynamo.velocity;

/**
 * An interface implemented by output objects which may be rendered by the Velocity template engine.
 * These objects supply the <EM>resource name</EM> of the Velocity template to the rendering engine,
 * which loads it from resources and executes it with the contained parameters.
 * <P>Objects that implement this interface are rendered by the
 * {@link com.silverwrist.dynamo.velocity.VelocityRenderer VelocityRenderer} component.
 *
 * @author Eric J. Bowersox &lt;erbo@silcom.com&gt;
 * @version X
 */
public interface VelocityRenderable extends VelocityParamSupplier
{
  /**
   * Returns the MIME type of the output to be rendered.  Usually, this will be "text/html".
   *
   * @return The MIME type of the output.
   */
  public String getMimeType();

  /**
   * Returns the resource name of the Velocity template to be used in rendering this object.  This pathname
   * is interpreted relative to the "resource root path" specified in the Velocity renderer's configuration.
   * The template engine loads it via the standard
   * {@link com.silverwrist.dynamo.iface.ResourceProvider ResourceProvider}, and then applies the parameters
   * contained in this object to it.
   *
   * @return The resource pathname of the Velocity template to use.
   */
  public String getTemplateName();

} // end interface VelocityRenderable
