01: /* Copyright 2001 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: /**
09: * <p>The <code>IChannelRendererFactory</code> interface defines the factory
10: * interface for <code>IChannelRenderer</code> objects. Provider
11: * implementations must provide a single string argument constructor. The
12: * string argument passed to the implementation is the key base used to
13: * construct the <code>IChannelRendererFactory</code> instance in the
14: * <code>ChannelRendererFactory.newInstance</code> method call. The
15: * implementation may use this argument to retrieve additional configuration
16: * parameters, if necessary.</p>
17: *
18: * @see org.jasig.portal.ChannelRendererFactory
19: *
20: * @author <a href="mailto:jnielsen@sct.com">Jan Nielsen</a>
21: *
22: * @version $Revision: 42516 $
23: **/
24: public interface IChannelRendererFactory {
25: /** <p> Class version identifier.</p> */
26: public final static String RCS_ID = "@(#) $Header$";
27:
28: /**
29: * <p>Creates a new instance of a channel renderer object for the provided
30: * channel and runtime data instances.</p>
31: *
32: * @param channel channel to render
33: *
34: * @param channelRuntimeData runtime data for the channel to render
35: *
36: * @return new instance of a channel renderer for the specified channel
37: **/
38: IChannelRenderer newInstance(IChannel channel,
39: ChannelRuntimeData channelRuntimeData,
40: PortalControlStructures pcs);
41: }
|