public class ParameterServiceImpl extends Object implements ParameterService
ParameterService
.Constructor and Description |
---|
ParameterServiceImpl() |
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, returning null if the parameter cannot be found or is not a boolean.
|
Boolean |
getParameterValueAsBoolean(Class<?> componentClass,
String parameterName,
Boolean defaultValue)
Retrieves a parameter's boolean value, returning
defaultValue if the parameter cannot be found or is not
a boolean. |
Boolean |
getParameterValueAsBoolean(String namespaceCode,
String componentCode,
String parameterName)
Retrieves a parameter's boolean value, returning null if the parameter cannot be found or is not a boolean.
|
Boolean |
getParameterValueAsBoolean(String namespaceCode,
String componentCode,
String parameterName,
Boolean defaultValue)
Retrieves a parameter's boolean value, returning
defaultValue if the parameter cannot be found or is not
a boolean. |
String |
getParameterValueAsFilteredString(Class<?> componentClass,
String parameterName)
Retrieves a parameter's string value filtered through the deploy time configuration variables, returning null if
the parameter cannot be found.
|
String |
getParameterValueAsFilteredString(Class<?> componentClass,
String parameterName,
String defaultValue)
Retrieves a parameter's string value filtered through the deploy time configuration variables, returning an
unfiltered
defaultValue if the parameter cannot be found. |
String |
getParameterValueAsFilteredString(String namespaceCode,
String componentCode,
String parameterName)
Retrieves a parameter's string value filtered through the deploy time configuration variables, returning null if
the parameter cannot be found.
|
String |
getParameterValueAsFilteredString(String namespaceCode,
String componentCode,
String parameterName,
String defaultValue)
Retrieves a parameter's string value filtered through the deploy time configuration variables, returning an
unfiltered
defaultValue if the parameter cannot be found. |
String |
getParameterValueAsString(Class<?> componentClass,
String parameterName)
Retrieves a parameter's string value, returning null if the parameter cannot be found.
|
String |
getParameterValueAsString(Class<?> componentClass,
String parameterName,
String defaultValue)
Retrieves a parameter's string value, returning
defaultValue if the parameter cannot be found. |
String |
getParameterValueAsString(String namespaceCode,
String componentCode,
String parameterName)
Retrieves a parameter's string value, returning null if the parameter cannot be found.
|
String |
getParameterValueAsString(String namespaceCode,
String componentCode,
String parameterName,
String defaultValue)
Retrieves a parameter's string value, returning
defaultValue if the parameter cannot be found. |
Collection<String> |
getParameterValuesAsFilteredString(Class<?> componentClass,
String parameterName)
Retrieves a parameter's string values where a parameter contains 0 or more values, filtered through the deploy
time configuration variables.
|
Collection<String> |
getParameterValuesAsFilteredString(String namespaceCode,
String componentCode,
String parameterName)
Retrieves a parameter's string values where a parameter contains 0 or more values, filtered through the deploy
time configuration variables.
|
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 |
getSubParameterValueAsFilteredString(Class<?> componentClass,
String parameterName,
String subParameterName)
Retrieves a subParameter's string value filtered through the deploy time configuration variables, returning null
if the subParameter cannot be found.
|
String |
getSubParameterValueAsFilteredString(String namespaceCode,
String componentCode,
String parameterName,
String subParameterName)
Retrieves a subParameter's string value filtered through the deploy time configuration variables, returning null
if the subParameter cannot be found.
|
String |
getSubParameterValueAsString(Class<?> componentClass,
String parameterName,
String subParameterName)
Retrieves a subParameter's string value, returning null if the subParameter cannot be found.
|
String |
getSubParameterValueAsString(String namespaceCode,
String componentCode,
String parameterName,
String subParameterName)
Retrieves a subParameter's string value, returning null if the subParameter cannot be found.
|
Collection<String> |
getSubParameterValuesAsFilteredString(Class<?> componentClass,
String parameterName,
String subParameterName)
Retrieves a subParameter's string values where a subParameter contains 0 or more values, filtered through the
deploy time configuration variables.
|
Collection<String> |
getSubParameterValuesAsFilteredString(String namespaceCode,
String componentCode,
String parameterName,
String subParameterName)
Retrieves a subParameter's string values where a subParameter contains 0 or more values, filtered through the
deploy time configuration variables.
|
Collection<String> |
getSubParameterValuesAsString(Class<?> componentClass,
String parameterName,
String subParameterName)
Retrieves a subParameter's string values where a subParameter contains 0 or more values.
|
Collection<String> |
getSubParameterValuesAsString(String namespaceCode,
String componentCode,
String parameterName,
String subParameterName)
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, never returning null.
|
Boolean |
parameterExists(String namespaceCode,
String componentCode,
String parameterName)
This method checks if a parameter exists, never returning null.
|
void |
setApplicationId(String applicationId) |
void |
setKualiModuleService(KualiModuleService kualiModuleService) |
void |
setParameterRepositoryService(ParameterRepositoryService parameterRepositoryService) |
Parameter |
updateParameter(Parameter parameter)
This will update a
Parameter . |
public ParameterServiceImpl()
public Parameter createParameter(Parameter parameter)
Parameter
exactly like the parameter passed in.createParameter
in interface ParameterService
parameter
- the Parameter
to create.Parameter
.org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#createParameter(org.kuali.rice.coreservice.api.parameter.Parameter)} for details
public Parameter updateParameter(Parameter parameter)
Parameter
.updateParameter
in interface ParameterService
parameter
- the Parameter
to update.Parameter
.org.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#updateParameter(org.kuali.rice.coreservice.api.parameter.Parameter)} for details
public Parameter getParameter(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
getParameter
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameter(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Parameter getParameter(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameter
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameter(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Boolean parameterExists(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
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.
parameterExists
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namepublic Boolean parameterExists(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassIf 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.
parameterExists
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namepublic Boolean getParameterValueAsBoolean(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
getParameterValueAsBoolean
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Boolean getParameterValueAsBoolean(String namespaceCode, String componentCode, String parameterName, Boolean defaultValue)
defaultValue
if the parameter cannot be found or is not
a boolean.
The parameter key is constructed from the following:
getParameterValueAsBoolean
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namedefaultValue
- the value to return is the parameter does not exist. Can be any Boolean value including nullorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Boolean getParameterValueAsBoolean(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValueAsBoolean
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Boolean getParameterValueAsBoolean(Class<?> componentClass, String parameterName, Boolean defaultValue)
defaultValue
if the parameter cannot be found or is not
a boolean.
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValueAsBoolean
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namedefaultValue
- the value to return is the parameter does not exist. Can be any Boolean value including nullorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsString(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
getParameterValueAsString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsString(String namespaceCode, String componentCode, String parameterName, String defaultValue)
defaultValue
if the parameter cannot be found.
The parameter key is constructed from the following:
getParameterValueAsString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namedefaultValue
- the value to return is the parameter does not exist. Can be any string value including nullorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsString(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValueAsString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsString(Class<?> componentClass, String parameterName, String defaultValue)
defaultValue
if the parameter cannot be found.
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValueAsString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namedefaultValue
- the value to return is the parameter does not exist. Can be any string value including nullorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsFilteredString(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
getParameterValueAsFilteredString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsFilteredString(String namespaceCode, String componentCode, String parameterName, String defaultValue)
defaultValue
if the parameter cannot be found.
The parameter key is constructed from the following:
getParameterValueAsFilteredString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namedefaultValue
- the value to return is the parameter does not exist. Can be any string value including nullorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsFilteredString(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValueAsFilteredString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getParameterValueAsFilteredString(Class<?> componentClass, String parameterName, String defaultValue)
defaultValue
if the parameter cannot be found.
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValueAsFilteredString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namedefaultValue
- the value to return is the parameter does not exist. Can be any string value including nullorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Collection<String> getParameterValuesAsString(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValuesAsString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Collection<String> getParameterValuesAsString(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValuesAsString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Collection<String> getParameterValuesAsFilteredString(String namespaceCode, String componentCode, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValuesAsFilteredString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public Collection<String> getParameterValuesAsFilteredString(Class<?> componentClass, String parameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetParameterValuesAsFilteredString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey)} for details
public String getSubParameterValueAsString(String namespaceCode, String componentCode, String parameterName, String subParameterName)
The parameter key is constructed from the following:
getSubParameterValueAsString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public String getSubParameterValueAsString(Class<?> componentClass, String parameterName, String subParameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetSubParameterValueAsString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public String getSubParameterValueAsFilteredString(String namespaceCode, String componentCode, String parameterName, String subParameterName)
The parameter key is constructed from the following:
getSubParameterValueAsFilteredString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public String getSubParameterValueAsFilteredString(Class<?> componentClass, String parameterName, String subParameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetSubParameterValueAsFilteredString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public Collection<String> getSubParameterValuesAsString(String namespaceCode, String componentCode, String parameterName, String subParameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetSubParameterValuesAsString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public Collection<String> getSubParameterValuesAsString(Class<?> componentClass, String parameterName, String subParameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetSubParameterValuesAsString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public Collection<String> getSubParameterValuesAsFilteredString(String namespaceCode, String componentCode, String parameterName, String subParameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetSubParameterValuesAsFilteredString
in interface ParameterService
namespaceCode
- the namespace codecomponentCode
- the component codeparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public Collection<String> getSubParameterValuesAsFilteredString(Class<?> componentClass, String parameterName, String subParameterName)
The parameter key is constructed from the following:
ParameterConstants.NAMESPACE
annotation on the componentClassParameterConstants.COMPONENT
annotation on the componentClassgetSubParameterValuesAsFilteredString
in interface ParameterService
componentClass
- the class with the namespace & component annotationsparameterName
- the parameter namesubParameterName
- the subParameter nameorg.kuali.rice.coreservice.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.coreservice.api.parameter.ParameterKey, String)} for details
public void setKualiModuleService(KualiModuleService kualiModuleService)
public void setParameterRepositoryService(ParameterRepositoryService parameterRepositoryService)
public void setApplicationId(String applicationId)
Copyright © 2005–2014 The Kuali Foundation. All rights reserved.