/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/portal/trunk/portal-api/api/src/java/org/sakaiproject/portal/api/PortalRenderContext.java $
* $Id: PortalRenderContext.java 105079 2012-02-24 23:08:11Z ottenhoff@longsight.com $
***********************************************************************************
*
* Copyright (c) 2005, 2006, 2007, 2008 The Sakai Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.sakaiproject.portal.api;
/**
* This interface represent the Render Context, it allows the portal
* implementation to put values into the render context. There is a utility dump
* method to dump the context. Instances of this class should be created per
* request via an Implimention of the RenderContextEngine
*
* @author ieb
* @since Sakai 2.4
* @version $Rev: 105079 $
*
*/
public interface PortalRenderContext
{
/**
* Set a value agaaisnt a Key, normally a value might be a String,
* Collection or a Map, but depending on the render engine technology other
* objects may be acceptable.
*
* @param string
* @param value
*/
void put(String string, Object value);
/**
* Convert the render context to a string suitable for dumping to a log file
* or console.
*
* @return
*/
String dump();
/**
* Return true if the context needs this part of the portal
*
* @param includeOption
* @return
*/
boolean uses(String includeOption);
/**
* Get the render engine associated with this context.
*
* @return
*/
PortalRenderEngine getRenderEngine();
}