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