001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.sys.document.validation;
017    
018    import org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent;
019    
020    /**
021     * An interface for a simple validation
022     */
023    public interface Validation {
024        /**
025         * This method validates that certain parameters 
026         * @param parameters a list of parameters to validate
027         * @return true if validation should continue, false otherwise
028         */
029       public abstract boolean validate(AttributedDocumentEvent event);
030        
031       /**
032        * Returns whether the validation process should quit on the failure of this validation
033        * @return true if the validation process should quit, false otherwise
034        */
035       public abstract boolean shouldQuitOnFail();
036       
037       /**
038        * Stages the execution of a Validation
039        * @param event the event the validate
040        * @return the boolean result of the staged Validation
041        */
042       public abstract boolean stageValidation(AttributedDocumentEvent event);
043    }