| org.kuali.kfs.service.ParameterEvaluator
All known Subclasses: org.kuali.kfs.service.impl.AlwaysSucceedParameterEvaluatorImpl, org.kuali.kfs.service.impl.ParameterEvaluatorImpl,
| ParameterEvaluator | | public interface ParameterEvaluator extends Serializable(Code) | | This is a stateful wrapper for Parameters, which provides convenient methods to evaluate a constrained value against a Parameter.
|
| Method Summary | |
| public boolean | constraintIsAllow()
This method determines whether the parameter lists allowed values or denied values. | | public boolean | evaluateAndAddError(Class businessObjectOrDocumentClass, String constrainedPropertyName)
This method uses the evaluateAndAddError method. | | public boolean | evaluateAndAddError(Class businessObjectOrDocumentClass, String constrainedPropertyName, String userEditablePropertyName)
This method uses the evaluationSucceeds method to evaluate the constrainedValue. | | public boolean | evaluationSucceeds()
This method determines whether the constrainedValue specified when the ParameterEvaluator was created matches the parameter. | | public String | getParameterValuesForMessage()
This method creates a pretty String representation of parameter values for the user messages. | | public String | getValue()
This method returns the value of the correspnding Parameter. | | public void | setConstrainedValue(String constrainedValue)
|
| constraintIsAllow | | public boolean constraintIsAllow()(Code) | | This method determines whether the parameter lists allowed values or denied values.
boolean indicating whether the parameter lists allowed values |
| evaluateAndAddError | | public boolean evaluateAndAddError(Class businessObjectOrDocumentClass, String constrainedPropertyName)(Code) | | This method uses the evaluateAndAddError method. It passes the constrainedPropertyName as both the constrainedPropertyName
and the userEditablePropertyName, i.e. it should be used when they are one and the same.
Parameters:
businessObjectOrDocumentClass -
Parameters:
constrainedPropertyName - boolean indicating whether evaluation succeeded (see evaluationSucceeds) |
| evaluateAndAddError | | public boolean evaluateAndAddError(Class businessObjectOrDocumentClass, String constrainedPropertyName, String userEditablePropertyName)(Code) | | This method uses the evaluationSucceeds method to evaluate the constrainedValue. If evaluation does not succeed, it adds an
error for the user. The businessObjectOrDocumentClass, nameOfConstrainedProperty and userEditablePropertyName are used by
ParameterEvaluatorImpl to retrieve user friendly labels for the error message. The constrainedPropertyName corresponds to the
field that has the value that the parameter is evaluating. The userEditablePropertyName corresponds to the field that has the
value the user needs to correct to resolve the error. For example, the object type may be invalid, but the user needs to
change the object code in order to remedy that.
Parameters:
businessObjectOrDocumentClass -
Parameters:
userEditableFieldToHighlight -
Parameters:
nameOfconstrainedProperty - boolean indicating whether evaluation succeeded (see evaluationSucceeds) |
| evaluationSucceeds | | public boolean evaluationSucceeds()(Code) | | This method determines whether the constrainedValue specified when the ParameterEvaluator was created matches the parameter.
boolean indicating whether the constrained value adheres to the restriction specified by the combination of theparameter constraint and the parameter value |
| getParameterValuesForMessage | | public String getParameterValuesForMessage()(Code) | | This method creates a pretty String representation of parameter values for the user messages.
user-friendly String representation of Parameter values |
| getValue | | public String getValue()(Code) | | This method returns the value of the correspnding Parameter.
String value of underlying Parameter |
| setConstrainedValue | | public void setConstrainedValue(String constrainedValue)(Code) | | |
|
|