com.sun.portal.providers.containers
Interface ContainerProvider

All Known Implementing Classes:

ContainerProviderAdapter, JSPContainerProviderAdapter

public interface ContainerProvider

ContainerProvider defines the interface for implementing a container provider. A container provider is a provider that generates its views primarily by being a client of other provider objects. Here, a container provider is defined as a provider that has a selected and available channels list, and allows getting and setting of these lists. Selected channels are those that are visible on the portal page. Available channels are those that are available to be activated on the portal page. A selected channels list should only contain channels that are visisble when the containers displays its main view.

See Also:

Provider

Method Summary

List	getAvailableChannels() Gets the list of available channel names.
List	getSelectedChannels() Gets the list of selected channel names.
void	setAvailableChannels(List avail) Sets the list of available channel names.
void	setSelectedChannels(List sel) Sets the list of selected channel names.

Method Detail

getSelectedChannels

public List getSelectedChannels()
                         throws ProviderException

Gets the list of selected channel names. Selected Channels are channels that are visible on the portal page.

Returns:

The list of selected channel names, a list of string names.

Throws:

ProviderException - If the list of channel names cannot be returned.

getAvailableChannels

public List getAvailableChannels()
                          throws ProviderException

Gets the list of available channel names. Available Channels are channels that are available to be added to the portal page.

Returns:

The list of available channel names, a list of string names.

Throws:

ProviderException - If the list of channel names cannot be returned.

setSelectedChannels

public void setSelectedChannels(List sel)
                         throws ProviderException

Sets the list of selected channel names.

Throws:

ProviderException - If the list of channel names cannot be set.

setAvailableChannels

public void setAvailableChannels(List avail)
                          throws ProviderException

Sets the list of available channel names.

Throws:

ProviderException - If the list of channel names cannot be set.