Interface ModulePreferencesApi

@FeignClient(name="preferences-service",
             qualifiers="modulePreferencesApi")
public interface ModulePreferencesApi

A ModulePreferencesApi defines the public REST API to manage ModulePreferences.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
List<ModulePreferenceVO>	findByModule(String module)	Find and return all existing ModulePreferences that belong to a module.
ModulePreferenceVO	findByModuleAndKey(String module, String key)	Find and return one ModulePreference that belongs to a module and has the given key.

Method Details

findByModule

@GetMapping(value="/v1/preferences",
            params="module")
List<ModulePreferenceVO> findByModule(@RequestParam("module")
 String module)

Find and return all existing ModulePreferences that belong to a module.

Parameters:

module - The owning module of the preferences

Returns:

A list of ModulePreferenceVO

findByModuleAndKey

@GetMapping(value="/v1/preferences",
            params={"module","key"})
ModulePreferenceVO findByModuleAndKey(@RequestParam("module")
 String module,
 @RequestParam("key")
 String key)

Find and return one ModulePreference that belongs to a module and has the given key.

Parameters:

module - The owning module of the preference

key - The key of the preference

Returns:

One single instance