com.sap.workspaces.module.settings

Interface IModuleSettingsFactory

public interface IModuleSettingsFactory

Provides a method to retrieve the module settings (properties). This method can be used only by module instances; other components, such as module templates, cannot use it.

The following example illustrates how to access and use the factory:
IWorkspacesRuntime runtime = RuntimeFactory.getWorkspacesRuntime();
IModuleSettingsFactory settingsFactory = runtime.getService(IModuleSettingsFactory.class);
IModuleSettings settings = settingsFactory.getModuleSettings(moduleContext);


Method Summary

IModuleSettings	getModuleSettings(IModuleContext moduleContext) Returns the module settings for the specified module context
void	saveModuleSettings(IModuleSettings moduleSettings) Saves the specified module settings

Method Detail

getModuleSettings

IModuleSettings getModuleSettings(IModuleContext moduleContext)
                                  throws WorkspacesRuntimeException

Returns the module settings for the specified module context

Parameters:

moduleContext - the module context of the module instance to get the settings for.

Returns:

the module settings

Throws:

WorkspacesRuntimeException - if the module context is not valid

saveModuleSettings

void saveModuleSettings(IModuleSettings moduleSettings)
                        throws WorkspacesRuntimeException

Saves the specified module settings

Parameters:

moduleSettings - the settings to save

Throws:

WorkspacesRuntimeException - if an error occurs