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
 java.util.List getAvailableChannels()
          Gets the list of available channel names.
 java.util.List getSelectedChannels()
          Gets the list of selected channel names.
 int[] getSupportedWindowStates()
          Gets the supported window states.
 int getWindowState(java.lang.String channelName)
          Gets the window state of the channel.
 void setAvailableChannels(java.util.List avail)
          Sets the list of available channel names.
 void setSelectedChannels(java.util.List sel)
          Sets the list of selected channel names.
 void setWindowState(java.lang.String channelName, int windowState)
          Sets the window state of the channel.
 

Method Detail

getSelectedChannels

public java.util.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 java.util.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(java.util.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(java.util.List avail)
                          throws ProviderException
Sets the list of available channel names.

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

getWindowState

public int getWindowState(java.lang.String channelName)
                   throws ProviderException
Gets the window state of the channel. This method returns the window state for the channel passed in.

Parameters:
channelName - channel for which window state is requested.
Returns:
The window state
Throws:
ProviderException - If the window state cannot be returned.
See Also:
com.sun.portal.providers.containers.ContainerProvider#setWindowState()

setWindowState

public void setWindowState(java.lang.String channelName,
                           int windowState)
                    throws UnsupportedWindowStateException
Sets the window state of the channel.

Parameters:
channelName - channel for which window state needs to be set
windowState - The new window state.
Throws:
UnsupportedWindowStateException - If the window state cannot be set or if the window state passed in is not in supported window states.
See Also:
com.sun.portal.providers.containers.ContainerProvider#getWindowState(), getSupportedWindowStates()

getSupportedWindowStates

public int[] getSupportedWindowStates()
                               throws ProviderException
Gets the supported window states. This method returns an integer array of Window States supported

Returns:
Supported Window States as an integer array.
Throws:
ProviderException - If the window states cannot be returned.
See Also:
com.sun.portal.providers.containers.ContainerProvider#getWindowState(), com.sun.portal.providers.containers.ContainerProvider#setWindowState()