org.jasig.portal.channels.support
Interface IChannelTitle

All Known Implementing Classes:

TitledChannelRuntimeProperties

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface IChannelTitle

IChannelTitle is an interface for conveying the title of a channel.

Its current use (as of uPortal 2.5.1) is for marking a ChannelRuntimeProperties as conveying a dynamic channel title. That is, an IChannel returning a ChannelRuntimeProperties that implements IChannelTitle communicates to the framework a desired title for the channel, overriding any title declared at the time of channel publication.

Dynamic channel title capability is implemented in terms of this interface rather than in terms of detection of some particular ChannelRuntimeProperties subclass so that any existing or new ChannelRuntimeProperties subclassess can be made dynamically titled. Recommendation for channel implementors: use TitledChannelRuntimeProperties rather than writing a new ChannelRuntimeProperties subclass implementing this interface, where possible.

Since:

uPortal 2.5.1

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Method Summary

String

getChannelTitle() Deprecated. Get the desired channel title.

Method Detail

getChannelTitle

String getChannelTitle()

Deprecated.

Get the desired channel title. Returning null indicates that the channel is not specifying a dynamic title and will leave it up to "the uPortal framework" to provide a title for the channel.

Currently, the fallback behavior is to behave as if the channel hadn't provided an IDynamicChannelTitle at all and use the title specified at channel publication.

Returns:

desired dynamic channel title, or null if no dynamic title.