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