001    /**
002    The contents of this file are subject to the Mozilla Public License Version 1.1 
003    (the "License"); you may not use this file except in compliance with the License. 
004    You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005    Software distributed under the License is distributed on an "AS IS" basis, 
006    WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007    specific language governing rights and limitations under the License. 
008    
009    The Original Code is "PrimitiveTypeRule.java".  Description: 
010    "A rule that applies to a primitive datatype. " 
011    
012    The Initial Developer of the Original Code is University Health Network. Copyright (C) 
013    2002.  All Rights Reserved. 
014    
015    Contributor(s): ______________________________________. 
016    
017    Alternatively, the contents of this file may be used under the terms of the 
018    GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
019    applicable instead of those above.  If you wish to allow use of your version of this 
020    file only under the terms of the GPL and not to allow others to use your version 
021    of this file under the MPL, indicate your decision by deleting  the provisions above 
022    and replace  them with the notice and other provisions required by the GPL License.  
023    If you do not delete the provisions above, a recipient may use your version of 
024    this file under either the MPL or the GPL. 
025    */
026    
027    package ca.uhn.hl7v2.validation;
028    
029    /**
030     * A rule that applies to a primitive datatype. 
031     * @author Bryan Tripp
032     */
033    public interface PrimitiveTypeRule extends Rule {
034     
035        /**
036         * Optionally performs an automatic correction on given data to make it 
037         * conform (eg trims leading whitespace).  This is to be called prior to 
038         * test().  If no corrections are performed, the original value is returned. 
039         * 
040         * @param value an original value to be corrected 
041         * @return a corrected version of the given value 
042         */
043        public String correct(String value);
044    
045        /**
046         * Tests the given string against the criteria defined by this 
047         * rule -- returns true if it passes the test, false otherwise.  
048         */
049        public boolean test(String value);
050        
051    }