View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.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.osedu.org/licenses/ECL-2.0
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.r2.lum.clu.infc;
17  
18  import org.kuali.student.r2.common.infc.HasAttributesAndMeta;
19  import org.kuali.student.r2.common.infc.HasId;
20  import org.kuali.student.r2.common.infc.HasType;
21  import org.kuali.student.r2.common.infc.RichText;
22  
23  /**
24   * Detailed information about an LU Code.
25   * 
26   * Each code is intended as a way to classify a learning unit.
27   * Examples include: CIP 2000 and 2010 codes (classification of instructional programs) 
28   * from the US government  but also include a university specific classification codes
29   */
30  public interface LuCode extends HasAttributesAndMeta, HasType, HasId {
31  
32      /**
33       * The Lu code's value
34       *
35       * @name Value
36       */
37      public String getValue();
38      
39      /**
40       * An optional description describing the code's value
41       *
42       * @name Description
43       */
44      public RichText getDescr();
45  }