001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.rule;
017
018import org.kuali.rice.kew.api.validation.RuleValidationContext;
019import org.kuali.rice.kew.api.validation.ValidationResults;
020
021/**
022 * A simple interface for handling validation of rules.  Validation results are returned in a
023 * ValidationResults object which consists of a series of error messages regarding the
024 * rule.  The user who is adding or editing the rule is passed to validate as well as the
025 * rule to be validated.
026 * 
027 * @author Kuali Rice Team (rice.collab@kuali.org)
028 */
029public interface RuleValidationAttribute {
030        
031        /**
032         * Validates the rule within the given RuleValidationContext.
033         * 
034         * @return a ValidationResults object representing the results of the validation, if this is
035         * empty or <code>null</code> this signifies that validation was successful.
036         */
037        public ValidationResults validate(RuleValidationContext validationContext);
038
039}