View Javadoc

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  import org.kuali.rice.krad.datadictionary.validation.constraint.Constraint;
20  
21  /**
22   * A Base constriant.
23   *
24   * @author nwright
25   */
26  
27  public interface BaseConstraintInfc 
28      extends Constraint {
29  	
30  
31      /**
32       * LabelKey should be a single word key.  This key is used to find
33       * a message to use for this constraint from available messages.
34       * The key is also used for defining/retrieving validation method
35       * names when applicable - as such this key MUST exist for valid
36       * character constraints.
37       *
38       * @name Label Key
39       */
40      public String getLabelKey();
41  
42      /**
43       * If this is true, the constraint should be applied on the client
44       * side when the user interacts with a field - if this constraint
45       * can be interpreted for client side use. Default is true.
46       *
47       * @name Is Apply Client Side
48       */
49      public Boolean getIsApplyClientSide();
50  }