Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
RuleValidationAttribute |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright 2005-2011 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.opensource.org/licenses/ecl2.php | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | package org.kuali.rice.kew.rule; | |
17 | ||
18 | import org.kuali.rice.kew.api.validation.RuleValidationContext; | |
19 | import org.kuali.rice.kew.api.validation.ValidationResults; | |
20 | ||
21 | /** | |
22 | * A simple interface for handling validation of rules. Validation results are returned in a | |
23 | * ValidationResults object which consists of a series of error messages regarding the | |
24 | * rule. The user who is adding or editing the rule is passed to validate as well as the | |
25 | * rule to be validated. | |
26 | * | |
27 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
28 | */ | |
29 | public interface RuleValidationAttribute { | |
30 | ||
31 | /** | |
32 | * Validates the rule within the given RuleValidationContext. | |
33 | * | |
34 | * @return a ValidationResults object representing the results of the validation, if this is | |
35 | * empty or <code>null</code> this signifies that validation was successful. | |
36 | */ | |
37 | public ValidationResults validate(RuleValidationContext validationContext); | |
38 | ||
39 | } |