View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 1.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/ecl1.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.student.datadictionary.infc;
17  
18  /**
19   * Constraint that applied a regular expression to check if the characters are valid
20   *
21   * @author nwright
22   */
23  public interface ValidCharactersConstraintInfc extends BaseConstraintInfc {
24  
25  	 /**
26        * Name: Value
27        *
28       * The Java based regex for valid characters
29        * There are two forms:
30        * regex:xxxxx
31        * and just
32        * xxxx
33        *
34        * If the 2nd form then it is interpreted as a simple list of valid characters.
35        *
36        * Note: it is actualy converted to a regular expression by wrapping it in [].
37       */
38      public String getValue();
39  
40  
41  
42  	/**
43       * Name: Java Script Value
44       *
45  	 * Javascript version of the regex defined in value.  This does not have to be set if this constraint's
46  	 * key maps to one of the default valid character methods contained in jQuery - (insert that list here).
47  	 * This must be set if there is NO default method that matches the label key and applyClientSide is true.
48  	 *
49  	 * This is completely ignored if applyClientSide is set to false.
50  	 */
51  	public String getJsValue();
52  
53     
54  }