Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal.channels.support
Interface IChannelTitle

All Known Implementing Classes:
  TitledChannelRuntimeProperties

    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 @link{ChannelRuntimeProperties} as conveying a dynamic channel title. That is, an @link{IChannel} returning a @link{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 @link{ChannelRuntimeProperties} subclass so that any existing or new @link{ChannelRuntimeProperties} subclassess can be made dynamically titled. Recommendation for channel implementors: use

Since:
  uPortal 2.5.1
Version:
  $Revision: 1.1.2.1 $ $Date: 2005/09/28 19:32:08 $

Method Summary
`java.lang.String` | `getChannelTitle()` Get the desired channel title.

Method Detail

### getChannelTitle

    java.lang.String getChannelTitle()

  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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD