01: /* Copyright 2003 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal;
07:
08: import java.io.PrintWriter;
09:
10: /**
11: * An optional channel interface that allows channels to provide their content in a character form (as opposed to XML form).
12: * Note: If a particular channel implements this optional interface, the portal
13: * will make use of it if and only if character caching portal setting is turned on.
14: * (it is not necessary for the channel to support caching, but character caching needs to be enabled for the portal)
15: * @author Peter Kharchenko {@link <a href="mailto:pkharchenko@interactivebusiness.com"">pkharchenko@interactivebusiness.com"</a>}
16: * @author <a href="mailto:nbolton@unicon.net">Nick Bolton</a>
17: * @version $Revision: 36690 $
18: */
19: public interface ICharacterChannel extends IChannel {
20: /**
21: * Asks the channel to render its content as characters.
22: * The method has the same call precedence as the IChannel.renderXML() method.
23: * (i.e. if the channel also supports ICacheable, portal will try to find a cache entry prior calling this method)
24: * @param pw a <code>PrintWriter</code> value into which the character output should be directed
25: * @exception PortalException if an error occurs
26: */
27: public void renderCharacters(PrintWriter pw) throws PortalException;
28: }
|