1 /*
2 * Copyright 2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.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.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
13 * implied. See the License for the specific language governing
14 * permissions and limitations under the License.
15 */
16
17 package org.kuali.student.enrollment.lui.infc;
18
19 import org.kuali.student.r2.common.infc.IdNamelessEntity;
20
21
22 /**
23 * Detailed information about a LUI Identifier.
24 */
25 public interface LuiIdentifier extends IdNamelessEntity {
26
27 /**
28 * The composite string that is used to officially reference or
29 * publish the LUI. Note it may have an internal structure that
30 * each Institution may want to enforce. This structure may be
31 * composed from the other parts of the structure such as Level
32 * amp; Division, but may include items such as luiType.
33 *
34 * @name Code
35 */
36 public String getCode();
37
38 /**
39 * Abbreviated name of the LUI, commonly used on transcripts.
40 *
41 * @name Short Name
42 */
43 public String getShortName();
44
45 /**
46 * The Long Name of the LUI.
47 *
48 * @name Long Name
49 */
50 public String getLongName();
51
52 /**
53 * A code that indicates whether this is introductory, advanced, etc.
54 *
55 * @name Level
56 */
57 public String getLevel();
58
59 /**
60 * A code that indicates what school, program, major, subject
61 * area, etc. Examples: "Chem", "18".
62 *
63 * @name Division
64 */
65 public String getDivision();
66
67 /*
68 * The "extra" portion of the code, which usually corresponds with
69 * the most detailed part of the number.
70 *
71 * @name Suffix Code
72 */
73 public String getSuffixCode();
74
75 /**
76 * A number that indicates the sequence or order of versions in
77 * cases where several different Clus have the same offical
78 * Identifier.
79 *
80 * @name Variation
81 */
82 public String getVariation();
83
84 /*
85 * The identifier of the organization associated with this luiIdentifier.
86 * @name Org Id
87 * @readOnly
88 */
89 public String getOrgId();
90 }