com.sapportals.wcm.rendering.layout
Class LayoutControllerFactory

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.layout_api.jar]

com.sapportals.wcm.rendering.layout.LayoutControllerFactory

All Implemented Interfaces:

IFactoryInfoProvider

public final class LayoutControllerFactory

implements IFactoryInfoProvider

Inner classes inherited from class com.sapportals.wcm.rendering.base.IFactoryInfoProvider

IFactoryInfoProvider.MappingInformation

Method Summary

void	configEvent(com.sapportals.config.event.ConfigEvent event) Calles by the ConfigurationFramework when changes are made the configuration
java.lang.String	getConfigListenerId() Implementation for the IConfigEventListener Gets the configListenerId attribute of the UICommandFactory object
java.lang.String	getFactoryName()
static LayoutControllerFactory	getInstance()
long	getLastReloadTime()
ILayoutController	getLayoutController(IProxy proxy, IResource resource) Returns a new instance of a ILayoutController If no configuration for the set of parameters can be retrieved or the mapping entry is faulty, the default LayoutController of the factory is returned.
ILayoutController	getLayoutController(IProxy proxy, ITypedResourceList resourcelist) Returns a new instance of a ILayoutController If no configuration for the set of parameters can be retrieved or the mapping entry is faulty, the default LayoutController of the factory is returned.
java.util.Properties	getMapping()
java.util.List	getMappings(java.util.Locale locale)
Status	getStatus()

Method Detail

getConfigListenerId

public java.lang.String getConfigListenerId()

Implementation for the IConfigEventListener Gets the configListenerId attribute of the UICommandFactory object

Returns:

The configListenerId value

configEvent

public void configEvent(com.sapportals.config.event.ConfigEvent event)

Calles by the ConfigurationFramework when changes are made the configuration

Parameters:

event - the event describing which changes occures in the config. The factory will reload its configuration when the event is of type ConfigEvent.CONFIGURABLE_LOADED or ConfigEvent.CONFIGMANAGER_TERMINATED.

getInstance

public static LayoutControllerFactory getInstance()

Returns:

the singleton instance of the LayoutControllerFactory. When this method is first called, the singleton instance reads out the configuration and fills its internal hashtable of LayoutControllers

getLayoutController

public ILayoutController getLayoutController(IProxy proxy,
                                             IResource resource)
                                      throws WcmException

Returns a new instance of a ILayoutController If no configuration for the set of parameters can be retrieved or the mapping entry is faulty, the default LayoutController of the factory is returned. The method uses the CustomizingControllerFactory to retrieve the mapped name for the given set of parameters.

Parameters:

proxy - the IProxy that called this method. It is set as parameter for the retrieved instance. The proxy's hashtable, that holds the iView/ URL-Parameter is used by the CustomizingControllerFactory to retrieve the matching mapping name.

resource - the resource that acts as the "root"-resource in the given IProxy

Returns:

an instance of ILayoutController that was configured for the given combination of input parameters. Does not return null. The instance is ready-to-use (no set-methods have to be called afterwards)

getLayoutController

public ILayoutController getLayoutController(IProxy proxy,
                                             ITypedResourceList resourcelist)
                                      throws WcmException

Returns a new instance of a ILayoutController If no configuration for the set of parameters can be retrieved or the mapping entry is faulty, the default LayoutController of the factory is returned. The method uses the CustomizingControllerFactory to retrieve the mapped name for the given set of parameters.

Parameters:

proxy - the IProxy that called this method. It is set as parameter for the retrieved instance. The proxy's hashtable, that holds the iView/ URL-Parameter is used by the CustomizingControllerFactory to retrieve the matching mapping name.

resourcelist - the list of resources displayed in the IProxy.

Returns:

an instance of ILayoutController that was configured for the given combination of input parameters. Does not return null. The instance is ready-to-use (no set-methods have to be called afterwards)

getMappings

public java.util.List getMappings(java.util.Locale locale)

Specified by:

getMappings in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Parameters:

locale - defines the language to use, if the factory offers translated information, must not be null

Returns:

a list that must only contain IFactoryInfoProvider.MappingInformation, must not be null

getMapping

public java.util.Properties getMapping()

getStatus

public Status getStatus()

Specified by:

getStatus in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Returns:

the aggregated status of the factory. If, e.g., there have been errors creating a class defined in the config, the factory should return Status.ERROR

getFactoryName

public java.lang.String getFactoryName()

Specified by:

getFactoryName in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Returns:

a human-readable name of the factory, must not be null

getLastReloadTime

public long getLastReloadTime()

Specified by:

getLastReloadTime in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Returns:

the time of the last reload of the config by this factory. Expects a format such as returned by System.currentTimeMillis(). An implementing class might also return -1 to indicate, that no information is available.