01: /* Copyright 2005 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.channels.support;
07:
08: /**
09: * Interface for IChannelRenderers that support dynamic channel titles.
10: * Dynamic channel titles were added in uPortal 2.5.1. In order to maintain
11: * backwards compatibility, rather than adding this method to IChannelRenderer
12: * itself, it is added to this optional extension interface. IChannelRenderers
13: * implementing this extention interface can take advantage of dynamic channel
14: * support in the uPortal framework (specifically, in ChannelManager).
15: * IChannelRenderers not changed to implement this interface will continue to
16: * behave exactly as before dynamic channel title capabilities were introduced.
17: * @since uPortal 2.5.1
18: */
19: public interface IDynamicChannelTitleRenderer {
20:
21: /**
22: * Get the dynamic channel title, if any, for the channel
23: * that this renderer has rendered.
24: *
25: * This method must not be executed concurently with outputRendering():
26: * the rendering framework should either first request the channel content
27: * and then requets the title, or first request the title and then request
28: * the channel content, but not both concurrently. Both this method and
29: * outputRendering() block on the channel rendering worker thread, blocking
30: * until the thread completes rendering the channel, or until the thread
31: * times out.
32: *
33: * @return String representing the dynamic channel title, or null if no
34: * dynamic channel title.
35: */
36: public String getChannelTitle();
37:
38: }
|