org.smartrplace.smarteff.access.api

Class DefaultGenericPageConfigurationProvider

java.lang.Object

org.smartrplace.smarteff.access.api.DefaultGenericPageConfigurationProvider

All Implemented Interfaces:

de.iwes.widgets.template.LabelledItem, GenericPageConfigurationProvider

public abstract class DefaultGenericPageConfigurationProvider
extends Object
implements GenericPageConfigurationProvider

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ID

Fields inherited from interface org.smartrplace.smarteff.access.api.GenericPageConfigurationProvider

SMARTREFF_URL_BASEPATH

Constructor Summary

Constructors

Constructor and Description
DefaultGenericPageConfigurationProvider() Note that OSGi creates new instance some times when old instances are still on the system.

Method Summary

Modifier and Type	Method and Description
String	addConfig(ConfigInfoExt sc) Add this to implementation class
protected abstract Map<String,ConfigInfoExt>	configs()
protected abstract DefaultGenericPageConfigurationProvider	getInstanceObj()
protected abstract String	getNextId()
protected static int	getNextId(int currentId, int maxId)
ConfigInfoExt	getSessionConfiguration(String configurationId) Get configuration for specific session
String	id() The id of the configurationProvider must be provided as parameter configProvider with URL
String	label(de.iwes.widgets.api.widgets.localisation.OgemaLocale locale)
void	saveCurrentConfiguration(ConfigInfoExt currentConfiguration, String configurationId) Current selections/configurations sent to the provider.
protected abstract void	setInstance(DefaultGenericPageConfigurationProvider instance)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iwes.widgets.template.LabelledItem

description

Field Detail

MAX_ID

public static final int MAX_ID

See Also:

Constant Field Values

Constructor Detail

DefaultGenericPageConfigurationProvider

public DefaultGenericPageConfigurationProvider()

Note that OSGi creates new instance some times when old instances are still on the system. So we make configs static, the static instance just reduces the number of objects around, but there will be several instances

Method Detail

configs

protected abstract Map<String,ConfigInfoExt> configs()

getNextId

protected abstract String getNextId()

addConfig

public String addConfig(ConfigInfoExt sc)

Add this to implementation class

getInstanceObj

protected abstract DefaultGenericPageConfigurationProvider getInstanceObj()

setInstance

protected abstract void setInstance(DefaultGenericPageConfigurationProvider instance)

getSessionConfiguration

public ConfigInfoExt getSessionConfiguration(String configurationId)

Description copied from interface: GenericPageConfigurationProvider

Get configuration for specific session

Specified by:

getSessionConfiguration in interface GenericPageConfigurationProvider

Parameters:

configurationId - paramter configurationId provided with URL. If the parameter is null a standard session configuration for the provider may be returned, but in this case also just null be returned, but no exception should be thrown.

Returns:

getNextId

protected static int getNextId(int currentId,
                               int maxId)

id

public String id()

Description copied from interface: GenericPageConfigurationProvider

The id of the configurationProvider must be provided as parameter configProvider with URL

Specified by:

id in interface de.iwes.widgets.template.LabelledItem

Specified by:

id in interface GenericPageConfigurationProvider

label

public String label(de.iwes.widgets.api.widgets.localisation.OgemaLocale locale)

Specified by:

label in interface de.iwes.widgets.template.LabelledItem

saveCurrentConfiguration

public void saveCurrentConfiguration(ConfigInfoExt currentConfiguration,
                                     String configurationId)

Description copied from interface: GenericPageConfigurationProvider

Current selections/configurations sent to the provider. The provider can save these configurations fully or partially or just ignore this information. The message is generated by the ScheduleViewer when a "Save Configuration" button is pressed.

Specified by:

saveCurrentConfiguration in interface GenericPageConfigurationProvider