org.kuali.rice.coreservice.impl.parameter

Class ParameterServiceImpl

java.lang.Object

org.kuali.rice.coreservice.impl.parameter.ParameterServiceImpl

All Implemented Interfaces:

ParameterService

public class ParameterServiceImpl
extends Object
implements ParameterService

Constructor Summary

Constructors

Constructor and Description
ParameterServiceImpl()

Method Summary

Modifier and Type	Method and Description
Parameter	createParameter(Parameter parameter) This will create a Parameter exactly like the parameter passed in.
Parameter	getParameter(Class<?> componentClass, String parameterName) Retrieves a parameter.
Parameter	getParameter(String namespaceCode, String componentCode, String parameterName) Retrieves a parameter.
Boolean	getParameterValueAsBoolean(Class<?> componentClass, String parameterName) Retrieves a parameter's boolean value.
Boolean	getParameterValueAsBoolean(Class<?> componentClass, String parameterName, Boolean defaultValue) Retrieves a parameter's boolean value.
Boolean	getParameterValueAsBoolean(String namespaceCode, String componentCode, String parameterName) Retrieves a parameter's boolean value.
Boolean	getParameterValueAsBoolean(String namespaceCode, String componentCode, String parameterName, Boolean defaultValue) Retrieves a parameter's boolean value.
String	getParameterValueAsString(Class<?> componentClass, String parameterName) Retrieves a parameter's string value.
String	getParameterValueAsString(Class<?> componentClass, String parameterName, String defaultValue) Retrieves a parameter's string value.
String	getParameterValueAsString(String namespaceCode, String componentCode, String parameterName) Retrieves a parameter's string value.
String	getParameterValueAsString(String namespaceCode, String componentCode, String parameterName, String defaultValue) Retrieves a parameter's string value.
Collection<String>	getParameterValuesAsString(Class<?> componentClass, String parameterName) Retrieves a parameter's string values where a parameter contains 0 or more values.
Collection<String>	getParameterValuesAsString(String namespaceCode, String componentCode, String parameterName) Retrieves a parameter's string values where a parameter contains 0 or more values.
String	getSubParameterValueAsString(Class<?> componentClass, String parameterName, String constrainingValue) Retrieves a subParameter's string value.
String	getSubParameterValueAsString(String namespaceCode, String componentCode, String parameterName, String constrainingValue) Retrieves a subParameter's string value.
Collection<String>	getSubParameterValuesAsString(Class<?> componentClass, String parameterName, String constrainingValue) Retrieves a subParameter's string values where a subParameter contains 0 or more values.
Collection<String>	getSubParameterValuesAsString(String namespaceCode, String componentCode, String parameterName, String constrainingValue) Retrieves a subParameter's string values where a subParameter contains 0 or more values.
Boolean	parameterExists(Class<?> componentClass, String parameterName) This method checks if a parameter exists.
Boolean	parameterExists(String namespaceCode, String componentCode, String parameterName) This method checks if a parameter exists.
void	setApplicationId(String applicationId)
void	setKualiModuleService(KualiModuleService kualiModuleService)
void	setParameterRepositoryService(ParameterRepositoryService parameterRepositoryService)
Parameter	updateParameter(Parameter parameter) This will update a Parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterServiceImpl

public ParameterServiceImpl()

Method Detail

createParameter

public Parameter createParameter(Parameter parameter)

Description copied from interface: ParameterService

This will create a Parameter exactly like the parameter passed in.

Specified by:

createParameter in interface ParameterService

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#createParameter(org.kuali.rice.coreservice.api.parameter.Parameter)} for details

updateParameter

public Parameter updateParameter(Parameter parameter)

Description copied from interface: ParameterService

This will update a Parameter.

Specified by:

updateParameter in interface ParameterService

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#updateParameter(org.kuali.rice.coreservice.api.parameter.Parameter)} for details

getParameter

public Parameter getParameter(String namespaceCode,
                              String componentCode,
                              String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameter in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

Returns:

true or false

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameter(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameter

public Parameter getParameter(Class<?> componentClass,
                              String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameter in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

Returns:

true or false

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameter(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

parameterExists

public Boolean parameterExists(String namespaceCode,
                               String componentCode,
                               String parameterName)

Description copied from interface: ParameterService

This method checks if a parameter exists. It will never return null.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

If the parameter does not exist under the application code, then this method will check if the parameter exists under the default rice application id and will return that parameter.

Specified by:

parameterExists in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

Returns:

true or false

parameterExists

public Boolean parameterExists(Class<?> componentClass,
                               String parameterName)

Description copied from interface: ParameterService

This method checks if a parameter exists. It will never return null.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

If the parameter does not exist under the application code, then this method will check if the parameter exists under the default rice application id and will return that parameter.

Specified by:

parameterExists in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

Returns:

true or false

getParameterValueAsBoolean

public Boolean getParameterValueAsBoolean(String namespaceCode,
                                          String componentCode,
                                          String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter's boolean value.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsBoolean in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

Returns:

true, false, null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsBoolean

public Boolean getParameterValueAsBoolean(String namespaceCode,
                                          String componentCode,
                                          String parameterName,
                                          Boolean defaultValue)

Description copied from interface: ParameterService

Retrieves a parameter's boolean value. If the parameter is not found the default value will be returned.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsBoolean in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

defaultValue - the value to return is the parameter does not exist. Can be any Boolean value including null

Returns:

true, false, or the defaultValue

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsBoolean

public Boolean getParameterValueAsBoolean(Class<?> componentClass,
                                          String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter's boolean value.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsBoolean in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

Returns:

true, false, null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsBoolean

public Boolean getParameterValueAsBoolean(Class<?> componentClass,
                                          String parameterName,
                                          Boolean defaultValue)

Description copied from interface: ParameterService

Retrieves a parameter's boolean value. If the parameter is not found the default value will be returned.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsBoolean in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

defaultValue - the value to return is the parameter does not exist. Can be any Boolean value including null

Returns:

true, false, or the defaultValue

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsString

public String getParameterValueAsString(String namespaceCode,
                                        String componentCode,
                                        String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter's string value.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsString in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

Returns:

string value or null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsString

public String getParameterValueAsString(String namespaceCode,
                                        String componentCode,
                                        String parameterName,
                                        String defaultValue)

Description copied from interface: ParameterService

Retrieves a parameter's string value. If the parameter is not found the default value will be returned.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsString in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

defaultValue - the value to return is the parameter does not exist. Can be any string value including null

Returns:

string value or null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsString

public String getParameterValueAsString(Class<?> componentClass,
                                        String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter's string value.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsString in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

Returns:

string value or null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValueAsString

public String getParameterValueAsString(Class<?> componentClass,
                                        String parameterName,
                                        String defaultValue)

Description copied from interface: ParameterService

Retrieves a parameter's string value. If the parameter is not found the default value will be returned.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValueAsString in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

defaultValue - the value to return is the parameter does not exist. Can be any string value including null

Returns:

string value or null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValuesAsString

public Collection<String> getParameterValuesAsString(String namespaceCode,
                                                     String componentCode,
                                                     String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter's string values where a parameter contains 0 or more values.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValuesAsString in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

Returns:

string values or empty Collection

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getParameterValuesAsString

public Collection<String> getParameterValuesAsString(Class<?> componentClass,
                                                     String parameterName)

Description copied from interface: ParameterService

Retrieves a parameter's string values where a parameter contains 0 or more values.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getParameterValuesAsString in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

Returns:

string values or empty Collection

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details

getSubParameterValuesAsString

public Collection<String> getSubParameterValuesAsString(String namespaceCode,
                                                        String componentCode,
                                                        String parameterName,
                                                        String constrainingValue)

Description copied from interface: ParameterService

Retrieves a subParameter's string values where a subParameter contains 0 or more values.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getSubParameterValuesAsString in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

constrainingValue - the subParameter name

Returns:

string values or empty Collection

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details

getSubParameterValuesAsString

public Collection<String> getSubParameterValuesAsString(Class<?> componentClass,
                                                        String parameterName,
                                                        String constrainingValue)

Description copied from interface: ParameterService

Retrieves a subParameter's string values where a subParameter contains 0 or more values.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getSubParameterValuesAsString in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

constrainingValue - the subParameter name

Returns:

string values or empty Collection

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details

getSubParameterValueAsString

public String getSubParameterValueAsString(String namespaceCode,
                                           String componentCode,
                                           String parameterName,
                                           String constrainingValue)

Description copied from interface: ParameterService

Retrieves a subParameter's string value.

The parameter key is constructed from the following:

• namespace code: from the passed in namespace code
• component code: from the passed in component code
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getSubParameterValueAsString in interface ParameterService

Parameters:

namespaceCode - the namespace code

componentCode - the component code

parameterName - the parameter name

constrainingValue - the subParameter name

Returns:

string value or null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details

getSubParameterValueAsString

public String getSubParameterValueAsString(Class<?> componentClass,
                                           String parameterName,
                                           String constrainingValue)

Description copied from interface: ParameterService

Retrieves a subParameter's string value.

The parameter key is constructed from the following:

• namespace code: from a ParameterConstants.NAMESPACE annotation on the componentClass
• component code: from a ParameterConstants.COMPONENT annotation on the componentClass
• parameter name: from the passed in parameter name
• application id: from the client configuration of the service implementation

Specified by:

getSubParameterValueAsString in interface ParameterService

Parameters:

componentClass - the class with the namespace & component annotations

parameterName - the parameter name

constrainingValue - the subParameter name

Returns:

string value or null

See Also:

org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details

setKualiModuleService

public void setKualiModuleService(KualiModuleService kualiModuleService)

setParameterRepositoryService

public void setParameterRepositoryService(ParameterRepositoryService parameterRepositoryService)

setApplicationId

public void setApplicationId(String applicationId)