net.datenwerke.gf.service.properties

Interface PropertiesService

All Known Implementing Classes:

PropertiesServiceImpl

public interface PropertiesService

A service that provides a way to store simple properties (key/value pairs) persistently in the database.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Returns true, if a property with the given key exists.
java.lang.String	get(java.lang.String key) Returns the property value or null.
java.util.List<Property>	getAllProperties() Returns all properties
Property	getPropertyById(java.lang.Long id) Retrieves a property by ID (note that the id is not the property's key)
Property	getPropertyByKey(java.lang.String name) Retrieves a property by key.
Property	merge(Property property) Merges a property
void	persist(Property property) Persists a property
void	remove(Property property) Removes a property
void	removeByKey(java.lang.String key) Removes a property by key.
Property	setProperty(java.lang.String key, java.lang.String value) Updates the property with the given key, or creates a new one if none exists.

Method Detail

getPropertyById

Property getPropertyById(java.lang.Long id)

Retrieves a property by ID (note that the id is not the property's key)

Parameters:

id -

See Also:

getPropertyByKey(String)

getPropertyByKey

Property getPropertyByKey(java.lang.String name)

Retrieves a property by key.

Parameters:

name -

containsKey

boolean containsKey(java.lang.String key)

Returns true, if a property with the given key exists.

Parameters:

key -

removeByKey

void removeByKey(java.lang.String key)

Removes a property by key.

Parameters:

key -

setProperty

Property setProperty(java.lang.String key,
                     java.lang.String value)

Updates the property with the given key, or creates a new one if none exists.

Parameters:

key -

value -

get

java.lang.String get(java.lang.String key)

Returns the property value or null.

Parameters:

key -

persist

void persist(Property property)

Persists a property

Parameters:

property -

merge

Property merge(Property property)

Merges a property

Parameters:

property -

remove

void remove(Property property)

Removes a property

Parameters:

property -

getAllProperties

java.util.List<Property> getAllProperties()

Returns all properties