com.sun.portal.providers.containers
Class ContainerProviderAdapter

java.lang.Object
  |
  +--com.sun.portal.providers.ProviderAdapter
        |
        +--com.sun.portal.providers.ProfileProviderAdapter
              |
              +--com.sun.portal.providers.containers.ContainerProviderAdapter

All Implemented Interfaces:

ContainerProvider, Provider, ProviderEditTypes, ProviderWidths

public class ContainerProviderAdapter

extends ProfileProviderAdapter

implements ContainerProvider

This class provides default implementations of methods in the ContainerProvider interface implemented using a containerProviderContext object as the persistent store. For method details, see the descriptions in the Provider interface.

See Also:

ContainerProviderContext, Provider

Fields inherited from interface com.sun.portal.providers.ProviderWidths

WIDTH_FULL_BOTTOM, WIDTH_FULL_TOP, WIDTH_THICK, WIDTH_THIN

Fields inherited from interface com.sun.portal.providers.ProviderEditTypes

EDIT_COMPLETE, EDIT_SUBSET

Constructor Summary

ContainerProviderAdapter()

Method Summary

List	getAvailableChannels() Gets the list of available channel names.
ContainerProviderContext	getContainerProviderContext() Gets the ContainerProviderContext for the container provider.
long	getRefreshTime() Gets the refresh time for the channel.
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.

Methods inherited from class com.sun.portal.providers.ProfileProviderAdapter

existsBooleanProperty, existsIntegerProperty, existsListProperty, existsListProperty, existsStringProperty, existsStringProperty, getBooleanProperty, getBooleanProperty, getClientProperty, getIntegerProperty, getIntegerProperty, getListProperty, getListProperty, getMapProperty, getMapProperty, getMapProperty, getMapProperty, getStringAttribute, getStringProperty, getStringProperty, getStringProperty, getStringProperty, getTemplate, getTemplate, isAllowed, setBooleanProperty, setClientProperty, setIntegerProperty, setListProperty, setMapProperty, setStringAttribute, setStringProperty

Methods inherited from class com.sun.portal.providers.ProviderAdapter

getContent, getContent, getDescription, getEdit, getEdit, getEditType, getHelp, getHelp, getName, getProviderContext, getResourceBundle, getResourceBundle, getTitle, getWidth, init, isEditable, isPresentable, processEdit, processEdit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContainerProviderAdapter

public ContainerProviderAdapter()

Method Detail

getContainerProviderContext

public ContainerProviderContext getContainerProviderContext()
                                                     throws ProviderException

Gets the ContainerProviderContext for the container provider.

Returns:

ContainerProviderContext.

See Also:

ContainerProviderContext

getSelectedChannels

public List getSelectedChannels()
                         throws ProviderException

Description copied from interface: ContainerProvider

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

Specified by:

getSelectedChannels in interface ContainerProvider

Following copied from interface: com.sun.portal.providers.containers.ContainerProvider

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

Description copied from interface: ContainerProvider

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

Specified by:

getAvailableChannels in interface ContainerProvider

Following copied from interface: com.sun.portal.providers.containers.ContainerProvider

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

Description copied from interface: ContainerProvider

Sets the list of selected channel names.

Specified by:

setSelectedChannels in interface ContainerProvider

Following copied from interface: com.sun.portal.providers.containers.ContainerProvider

Throws:

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

setAvailableChannels

public void setAvailableChannels(List avail)
                          throws ProviderException

Description copied from interface: ContainerProvider

Sets the list of available channel names.

Specified by:

setAvailableChannels in interface ContainerProvider

Following copied from interface: com.sun.portal.providers.containers.ContainerProvider

Throws:

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

getRefreshTime

public long getRefreshTime()
                    throws ProviderException

Description copied from class: ProviderAdapter

Gets the refresh time for the channel. The refresh time for a channel is used to allow containers to implement caching of content for their contained channels. This value is used to indicate the validity of the cached content.

Overrides:

getRefreshTime in class ProviderAdapter

Following copied from class: com.sun.portal.providers.ProviderAdapter

Returns:

>0, refresh time in number of seconds that a container should wait before expiring a content cache. 0, container should never cache channel's content. -1, container may cache channel's content indefinitely.

Throws:

ProviderException - If there was an error getting the refresh time for the channel.