org.smartrplace.smarteff.access.api

Interface GenericPageConfigurationProvider

All Superinterfaces:

de.iwes.widgets.template.LabelledItem

All Known Implementing Classes:

DefaultGenericPageConfigurationProvider

public interface GenericPageConfigurationProvider
extends de.iwes.widgets.template.LabelledItem

Field Summary

Fields

Modifier and Type	Field and Description
static String	SMARTREFF_URL_BASEPATH

Method Summary

Modifier and Type	Method and Description
ConfigInfoExt	getSessionConfiguration(String configurationId) Get configuration for specific session
String	id() The id of the configurationProvider must be provided as parameter configProvider with URL
void	saveCurrentConfiguration(ConfigInfoExt currentConfiguration, String configurationId) Current selections/configurations sent to the provider.

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

description, label

Field Detail

SMARTREFF_URL_BASEPATH

static final String SMARTREFF_URL_BASEPATH

See Also:

Constant Field Values

Method Detail

id

String id()

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

Specified by:

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

getSessionConfiguration

ConfigInfoExt getSessionConfiguration(String configurationId)

Get configuration for specific session

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:

saveCurrentConfiguration

void saveCurrentConfiguration(ConfigInfoExt currentConfiguration,
                              String configurationId)

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.