com.whitestein.lsps.engine

Interface SettingManagementService

All Known Subinterfaces:

SettingManagementServiceLocal, SettingManagementServiceRemote

All Known Implementing Classes:

SettingManagementServiceBean

public interface SettingManagementService

Engine settings management interface.

Author:

jsa

Method Summary

Modifier and Type	Method and Description
Setting	create(java.lang.String id, java.lang.String value) Creates a new engine setting with the provided values.
void	delete(java.lang.String id) Deletes a given settings.
java.util.List<Setting>	findAll() Finds all engine settings.
Setting	get(java.lang.String id) Returns an engine setting with the given id.
Setting	update(java.lang.String id, java.lang.String value) Updates an engine setting with the given value.

Method Detail

findAll

java.util.List<Setting> findAll()

Finds all engine settings.

Returns:

a list of engine settings

get

Setting get(java.lang.String id)
     throws LspsSettingsException

Returns an engine setting with the given id.

Parameters:

id - the identifier of the setting

Returns:

the setting

Throws:

LspsSettingsException -

• If any of the input parameter is not valid.

create

Setting create(java.lang.String id,
               java.lang.String value)
        throws LspsSettingsException

Creates a new engine setting with the provided values.

Parameters:

id - the identifier of the setting

value - the value of the setting

Returns:

the create setting

Throws:

LspsSettingsException -

• If the setting identifier is not unique.
• If any of the input parameter is not valid.

update

Setting update(java.lang.String id,
               java.lang.String value)
        throws LspsSettingsException

Updates an engine setting with the given value.

Parameters:

id - the identifier of the setting

value - the new value of the setting

Returns:

the updated setting

Throws:

LspsSettingsException -

• if no setting with the given identifier is found.
• If any of the input parameter is not valid.

delete

void delete(java.lang.String id)
     throws LspsSettingsException

Deletes a given settings.

Parameters:

id - the setting identifier

Throws:

LspsSettingsException - if no setting with the given identifier is found