| java.lang.Object
 org.kuali.kfs.service.impl.ParameterServiceImpl
| ParameterServiceImpl | | public class ParameterServiceImpl implements ParameterService(Code) | | See ParameterService. The componentClass must be the business object, document, or step class that the parameter is associated
with. Implementations of this class know how to translate that to a namespace (for ParameterService Impl, determine what module
the Class is associated with by parsing the package) and detail type (for ParameterServiceImpl, document Class --> use simple
class name minus the word Document / business object Class --> use simple class name, batch step class --> use the simple class
name). In cases where the parameter is applicable to all documents, all lookups, all batch steps, or all components in a
particular module, you should pass in the appropriate constant class in ParameterConstants for the component Class (e.g. all
purchasing documents = PURCHASING_DOCUMENT.class, all purchasing lookups = PURCHASING_LOOKUP.class, all purchasing batch steps =
PURCHASING_BATCH.class, and all purchasing components = PURCHASING_ALL.class). In addition, certain methods take
constrainingValue and constrainedValue Strings. The constrainedValue is the value that you want to compare to the Parameter
value, and the constrainingValue is used for complex parameters that limit one field value based on the value of another field,
e.g VALID_OBJECT_LEVELS_BY_OBJECT_TYPE.
|
| Method Summary | |
| public boolean | getIndicatorParameter(Class componentClass, String parameterName)
This method provides a convenient way to access the value of indicator parameters with Y/N values. | | public List<ParameterDetailType> | getNonDatabaseDetailTypes()
This method derived ParameterDetailedTypes from the DataDictionary for all BusinessObjects and Documents and from Spring for
all batch Steps. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String parameterName)
This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and parameterName and the values of the Parameter. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String parameterName, String constrainedValue)
This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and parameterName, the values of the Parameter, the knowledge of whether the
values are allowed or denied, and the constrainedValue. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String parameterName, String constrainingValue, String constrainedValue)
This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and parameterName, the values of the Parameter that correspond to the specified
constrainingValue, the knowledge of whether the values are allowed or denied, and the constrainedValue. | | public ParameterEvaluator | getParameterEvaluator(Class componentClass, String allowParameterName, String denyParameterName, String constrainingValue, String constrainedValue)
This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and allowParameterName or to the specified componentClass and denyParameterName
(depending on which restricts based on the constraining value) or an instance of AlwaysSucceedParameterEvaluatorImpl if
neither restricts, the values of the Parameter that correspond to the specified constrainingValue, the knowledge of whether
the values are allowed or denied, and the constrainedValue. | | 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)
| | public String | getParameterValue(Class componentClass, String parameterName, String constrainingValue)
This will look for constrainingValue= within the parameter text and return that if it is found. | | public List<String> | getParameterValues(Class componentClass, String parameterName)
This method can be used to parse the value of a parameter by splitting on a semi-colon. | | public List<String> | getParameterValues(Class componentClass, String parameterName, String constrainingValue)
This method looks for constrainingValue= within the parameter text and splits that text on a comma to generate
the List to return. | | public boolean | parameterExists(Class componentClass, String parameterName)
| | public void | setBusinessObjectService(BusinessObjectService businessObjectService)
| | public void | setDataDictionaryService(DataDictionaryService dataDictionaryService)
| | public void | setModuleService(KualiModuleService moduleService)
| | public void | setParameterForTesting(Class componentClass, String parameterName, String parameterText)
|
| getIndicatorParameter | | public boolean getIndicatorParameter(Class componentClass, String parameterName)(Code) | | This method provides a convenient way to access the value of indicator parameters with Y/N values. Y is translated to true
and N is translated to false.
Parameters:
componentClass -
Parameters:
parameterName - boolean value of Yes/No indicator parameter |
| getNonDatabaseDetailTypes | | public List<ParameterDetailType> getNonDatabaseDetailTypes()(Code) | | This method derived ParameterDetailedTypes from the DataDictionary for all BusinessObjects and Documents and from Spring for
all batch Steps.
List containing the detailed types derived from the data dictionary and Spring |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String parameterName)(Code) | | This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and parameterName and the values of the Parameter.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator instance initialized with the Parameter corresponding to the specified componentClass andparameterName and the values of the Parameter |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String parameterName, String constrainedValue)(Code) | | This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and parameterName, the values of the Parameter, the knowledge of whether the
values are allowed or denied, and the constrainedValue.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator instance initialized with the Parameter corresponding to the specified componentClass andparameterName, the values of the Parameter, the knowledge of whether the values are allowed or denied, and theconstrainedValue |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String parameterName, String constrainingValue, String constrainedValue)(Code) | | This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and parameterName, the values of the Parameter that correspond to the specified
constrainingValue, the knowledge of whether the values are allowed or denied, and the constrainedValue.
Parameters:
componentClass -
Parameters:
parameterName - ParameterEvaluator instance initialized with the Parameter corresponding to the specified componentClass andparameterName, the values of the Parameter that correspond to the specified constrainingValue, the knowledge ofwhether the values are allowed or denied, and the constrainedValue |
| getParameterEvaluator | | public ParameterEvaluator getParameterEvaluator(Class componentClass, String allowParameterName, String denyParameterName, String constrainingValue, String constrainedValue)(Code) | | This method will return an instance of the parameterEvaluator bean defined in Spring, initialized with the Parameter
corresponding to the specified componentClass and allowParameterName or to the specified componentClass and denyParameterName
(depending on which restricts based on the constraining value) or an instance of AlwaysSucceedParameterEvaluatorImpl if
neither restricts, the values of the Parameter that correspond to the specified constrainingValue, the knowledge of whether
the values are allowed or denied, and the constrainedValue.
Parameters:
componentClass -
Parameters:
allowParameterName -
Parameters:
denyParameterName -
Parameters:
constrainingValue -
Parameters:
constrainedValue - AlwaysSucceedParameterEvaluatorImpl or ParameterEvaluator instance initialized with the Parameter that corresponds tothe constrainingValue restriction, the values of the Parameter that correspond to the specified constrainingValue,the knowledge of whether the values are allowed or denied, and the constrainedValue |
| getParameterValue | | public String getParameterValue(Class componentClass, String parameterName, String constrainingValue)(Code) | | This will look for constrainingValue= within the parameter text and return that if it is found. Otherwise,
it will return null. Note, that if constrainingValue=value1,value2... (commas specific to the ParameterServiceImpl
implementation) is found it will still return null, because calling this method states the assumption that there is only one
value within the parameter text that corresponds to the constraining value.
Parameters:
componentClass -
Parameters:
parameterName -
Parameters:
constrainingValue - derived value String or null |
| getParameterValues | | public List<String> getParameterValues(Class componentClass, String parameterName)(Code) | | This method can be used to parse the value of a parameter by splitting on a semi-colon.
Parameters:
componentClass -
Parameters:
parameterName - parsed List of String parameter values |
| getParameterValues | | public List<String> getParameterValues(Class componentClass, String parameterName, String constrainingValue)(Code) | | This method looks for constrainingValue= within the parameter text and splits that text on a comma to generate
the List to return.
Parameters:
componentClass -
Parameters:
parameterName -
Parameters:
constrainingValue - derived values List or an empty list if no values are found |
|
|