| org.kuali.kfs.service.ParameterService
All known Subclasses: org.kuali.kfs.service.impl.ParameterServiceImpl,
| ParameterService | | public interface ParameterService (Code) | | This class provides methods to verify the existence of Parameters, get the value(s), and get ParameterEvaluators. For the most
part, your code should be asking for a ParameterEvaluator and interacting with that. For optional parameters (ones that may not
exist but should be processed if they do), you will want to use the parameterExists method before using other methods, since an
exception will be thrown by the other methods if the referenced parameter does not exist. In some cases you may need to just pull
the value(s) of a parameter via the getParameterValue(s) or getIndicatorParameter methods. All of the methods that you will want
to use take a Class componentClass and String parameterName argument. Implementations of this class know how to translate these
appropriately to retrieve Parameters and construct ParameterEvaluators.
|
| Method Summary | |
| public boolean | getIndicatorParameter(Class componentClass, String parameterName)
This method provides a convenient way to access the a parameter that signifies true or false. | | public List<ParameterDetailType> | getNonDatabaseDetailTypes()
This method can be used to supplement the list of ParameterDetailTypes defined in the database from other sources. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String parameterName)
This method will return an instance of a ParameterEvaluator implementation that will wrap a Parameter and provide convenient
evaluation methods. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String parameterName, String constrainedValue)
This method will return an instance of a ParameterEvaluator implementation that will wrap a Parameter and constrainedValue
and provide convenient evaluation methods. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String parameterName, String constrainingValue, String constrainedValue)
This method will return an instance of a ParameterEvaluator implementation that will wrap a Parameter, constrainingValue, and
constrainedValue and provide convenient evaluation methods. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String allowParameterName, String denyParameterName, String constrainingValue, String constrainedValue)
This method will return an instance of a ParameterEvaluator implementation that will wrap an allow Parameter, a deny
Parameter, constrainingValue, and constrainedValue and provide convenient evaluation methods. | | public List<ParameterEvaluator> | getParameterEvaluators(Class componentClass, String constrainedValue)
| | public List<ParameterEvaluator> | getParameterEvaluators(Class componentClass, String constrainingValue, String constrainedValue)
| | public String | getParameterValue(Class componentClass, String parameterName)
This method returns the unprocessed text value of a parameter. | | public String | getParameterValue(Class componentClass, String parameterName, String constrainingValue)
This method can be used to derive a value based on another value. | | public List<String> | getParameterValues(Class componentClass, String parameterName)
This method can be used to parse the value of a parameter. | | public List<String> | getParameterValues(Class componentClass, String parameterName, String constrainingValue)
This method can be used to derive a set of values based on another value. | | public boolean | parameterExists(Class componentClass, String parameterName)
This method provides an exception free way to ensure that a parameter exists. | | public void | setParameterForTesting(Class componentClass, String parameterName, String parameterText)
This method can be used to change the value of a Parameter for unit testing purposes. |
| getIndicatorParameter | | public boolean getIndicatorParameter(Class componentClass, String parameterName)(Code) | | This method provides a convenient way to access the a parameter that signifies true or false.
Parameters:
componentClass -
Parameters:
parameterName - boolean value of indicator parameter |
| getNonDatabaseDetailTypes | | public List<ParameterDetailType> getNonDatabaseDetailTypes()(Code) | | This method can be used to supplement the list of ParameterDetailTypes defined in the database from other sources.
List containing the detailed types configured in non-database sources |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String parameterName)(Code) | | This method will return an instance of a ParameterEvaluator implementation that will wrap a Parameter and provide convenient
evaluation methods.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String parameterName, String constrainedValue)(Code) | | This method will return an instance of a ParameterEvaluator implementation that will wrap a Parameter and constrainedValue
and provide convenient evaluation methods.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String parameterName, String constrainingValue, String constrainedValue)(Code) | | This method will return an instance of a ParameterEvaluator implementation that will wrap a Parameter, constrainingValue, and
constrainedValue and provide convenient evaluation methods.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String allowParameterName, String denyParameterName, String constrainingValue, String constrainedValue)(Code) | | This method will return an instance of a ParameterEvaluator implementation that will wrap an allow Parameter, a deny
Parameter, constrainingValue, and constrainedValue and provide convenient evaluation methods.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator |
| getParameterEvaluators | | public List<ParameterEvaluator> getParameterEvaluators(Class componentClass, String constrainedValue)(Code) | | This method returns ParameterEvaluators initialized per public ParameterEvaluator getParameterEvaluator(Class componentClass,
String parameterName, String constrainedValue)
Parameters:
componentClass -
Parameters:
constrainedValue - List initialized per public ParameterEvaluator getParameterEvaluator(Class componentClass,String parameterName, String constrainedValue) |
| getParameterEvaluators | | public List<ParameterEvaluator> getParameterEvaluators(Class componentClass, String constrainingValue, String constrainedValue)(Code) | | This method returns ParameterEvaluators initialized per public ParameterEvaluator getParameterEvaluator(Class componentClass,
String parameterName, String constrainingValue, String constrainedValue)
Parameters:
componentClass -
Parameters:
constrainedValue - List initialized per public ParameterEvaluator getParameterEvaluator(Class componentClass,String parameterName, String constrainingValue, String constrainedValue) |
| getParameterValue | | public String getParameterValue(Class componentClass, String parameterName)(Code) | | This method returns the unprocessed text value of a parameter.
Parameters:
componentClass -
Parameters:
parameterName - unprocessed string value os a parameter |
| getParameterValue | | public String getParameterValue(Class componentClass, String parameterName, String constrainingValue)(Code) | | This method can be used to derive a value based on another value.
Parameters:
componentClass -
Parameters:
parameterName -
Parameters:
constrainingValue - derived value |
| getParameterValues | | public List<String> getParameterValues(Class componentClass, String parameterName)(Code) | | This method can be used to parse the value of a parameter.
Parameters:
componentClass -
Parameters:
parameterName - parsed List of String parameter values |
| getParameterValues | | public List<String> getParameterValues(Class componentClass, String parameterName, String constrainingValue)(Code) | | This method can be used to derive a set of values based on another value.
Parameters:
componentClass -
Parameters:
parameterName -
Parameters:
constrainingValue - derived values List |
| parameterExists | | public boolean parameterExists(Class componentClass, String parameterName)(Code) | | This method provides an exception free way to ensure that a parameter exists.
Parameters:
componentClass -
Parameters:
parameterName - boolean indicating whether or not the parameter exists |
| setParameterForTesting | | public void setParameterForTesting(Class componentClass, String parameterName, String parameterText)(Code) | | This method can be used to change the value of a Parameter for unit testing purposes.
Parameters:
componentClass -
Parameters:
parameterName -
Parameters:
parameterText - |
|
|