org.broadleafcommerce.common.config.service

Interface SystemPropertiesService

All Known Implementing Classes:

SystemPropertiesServiceImpl

public interface SystemPropertiesService

To change this template use File | Settings | File Templates.

User: Kelly Tisdell Date: 6/25/12

Method Summary

Methods

Modifier and Type	Method and Description
SystemProperty	findById(Long id) Finds a SystemProperty by its internal id
boolean	isValueValidForType(String value, SystemPropertyFieldType type) Determines if the given value is valid for the specified type
void	removeFromCache(SystemProperty systemProperty) Evicts the given SystemProperty from the cache
boolean	resolveBooleanSystemProperty(String name) Resolves a boolean system property.
int	resolveIntSystemProperty(String name) Resolves an int system property.
long	resolveLongSystemProperty(String name) Resolves an long system property.
String	resolveSystemProperty(String name) Preferred method for looking up properties.

Method Detail

resolveSystemProperty

String resolveSystemProperty(String name)

Preferred method for looking up properties. The method will return the configured value or if no override value is found, it will return the value passed in to the method as the default value.

Parameters:

name -

Returns:

resolveIntSystemProperty

int resolveIntSystemProperty(String name)

Resolves an int system property. Returns 0 when no matching property is found.

Parameters:

name -

Returns:

resolveBooleanSystemProperty

boolean resolveBooleanSystemProperty(String name)

Resolves a boolean system property. Returns false when no matching system property is found.

Parameters:

name -

Returns:

resolveLongSystemProperty

long resolveLongSystemProperty(String name)

Resolves an long system property. Returns 0 when no matching property is found.

Parameters:

name -

Returns:

isValueValidForType

boolean isValueValidForType(String value,
                          SystemPropertyFieldType type)

Determines if the given value is valid for the specified type

Parameters:

sp -

Returns:

whether or not the SystemProperty is in a valid state

removeFromCache

void removeFromCache(SystemProperty systemProperty)

Evicts the given SystemProperty from the cache

Parameters:

systemProperty -

findById

SystemProperty findById(Long id)

Finds a SystemProperty by its internal id

Parameters:

id -

Returns:

the SystemProperty