org.kuali.rice.kns.service
Interface KualiConfigurationService

All Known Implementing Classes:

KualiConfigurationServiceImpl

public interface KualiConfigurationService

This interface defines methods that a KualiConfiguration Service must provide. Provides methods for getting string resources.

Method Summary

Properties	getAllProperties()
boolean	getIndicatorParameter(String namespaceCode, String detailTypeCode, String parameterName) Deprecated.
String	getParameterValue(String namespaceCode, String detailTypeCode, String parameterName) Deprecated.
List<String>	getParameterValues(String namespaceCode, String detailTypeCode, String parameterName) Deprecated.
boolean	getPropertyAsBoolean(String key) Given a property name (key), returns the "booleanized" value associated with that key.
String	getPropertyString(String key) Given a property name (key), returns the value associated with that key, or null if none is available.
boolean	isProductionEnvironment() Returns whether this instance is production based on the configuration options.

Method Detail

getPropertyString

String getPropertyString(String key)

Given a property name (key), returns the value associated with that key, or null if none is available.

Parameters:

key -

Returns:

String associated with the given key

Throws:

IllegalArgumentException - if the key is null

getPropertyAsBoolean

boolean getPropertyAsBoolean(String key)

Given a property name (key), returns the "booleanized" value associated with that key. true, yes, on, or 1 are translated into true - all other values result in false

Parameters:

key -

Returns:

String associated with the given key

Throws:

IllegalArgumentException - if the key is null

getAllProperties

Properties getAllProperties()

Returns:

Properties instance containing all (key,value) pairs known to the service

isProductionEnvironment

boolean isProductionEnvironment()

Returns whether this instance is production based on the configuration options.

getIndicatorParameter

@Deprecated
boolean getIndicatorParameter(String namespaceCode,
                                         String detailTypeCode,
                                         String parameterName)

Deprecated.

This method retrieves a parameter expected to have a Yes / no value and converts to a boolean for convenience

getParameterValues

@Deprecated
List<String> getParameterValues(String namespaceCode,
                                           String detailTypeCode,
                                           String parameterName)

Deprecated.

This method returns a list of the parameter values split on implementation specific criteria. For the default KualiConfigurationServiceImpl, the split is on a semi-colon.

getParameterValue

@Deprecated
String getParameterValue(String namespaceCode,
                                    String detailTypeCode,
                                    String parameterName)

Deprecated.

This method returns the value of the specified parameter