com.sapportals.wcm.rendering.base
Interface IFactoryInfoProvider

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

All Known Implementing Classes:

AbstractFactory, StatusFactory, ComponentFactory, LayoutControllerFactory, PropertyRendererFactory, UICommandFactory

public interface IFactoryInfoProvider

Since:

EP6, SP2 CP Factories used in the FlexUI-process should implement this interface, so the "Rendering Information" can show the current configuration of the factory.

Inner Class Summary

static class

IFactoryInfoProvider.MappingInformation

Method Summary

java.lang.String	getFactoryName()
long	getLastReloadTime()
java.util.List	getMappings(java.util.Locale locale)
Status	getStatus()

Method Detail

getFactoryName

public java.lang.String getFactoryName()

Returns:

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

getMappings

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

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

getStatus

public Status getStatus()

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

getLastReloadTime

public long getLastReloadTime()

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.