| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| LuiIdentifier |
|
| 1.0;1 |
| 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 java.util.List; | |
| 20 | ||
| 21 | import org.kuali.student.r2.common.infc.HasId; | |
| 22 | import org.kuali.student.r2.common.infc.TypeStateEntity; | |
| 23 | ||
| 24 | ||
| 25 | /** | |
| 26 | * Detailed information about a LUI Identifier. | |
| 27 | */ | |
| 28 | public interface LuiIdentifier | |
| 29 | extends HasId, TypeStateEntity { | |
| 30 | ||
| 31 | /** | |
| 32 | * The composite string that is used to officially reference or | |
| 33 | * publish the LUI. Note it may have an internal structure that | |
| 34 | * each Institution may want to enforce. This structure may be | |
| 35 | * composed from the other parts of the structure such as Level | |
| 36 | * amp; Division, but may include items such as luiType. | |
| 37 | * | |
| 38 | * @name Code | |
| 39 | */ | |
| 40 | public String getCode(); | |
| 41 | ||
| 42 | /** | |
| 43 | * Abbreviated name of the LUI, commonly used on transcripts. | |
| 44 | * | |
| 45 | * @name Short Name | |
| 46 | */ | |
| 47 | public String getShortName(); | |
| 48 | ||
| 49 | /** | |
| 50 | * The Long Name of the LUI. | |
| 51 | * | |
| 52 | * @name Long Name | |
| 53 | */ | |
| 54 | public String getLongName(); | |
| 55 | ||
| 56 | /** | |
| 57 | * A code that indicates what school, program, major, subject | |
| 58 | * area, etc. Examples: "Chem", "18". | |
| 59 | * | |
| 60 | * @name Division | |
| 61 | */ | |
| 62 | public String getDivision(); | |
| 63 | ||
| 64 | /* | |
| 65 | * The "extra" portion of the code, which usually corresponds with | |
| 66 | * the most detailed part of the number. | |
| 67 | * | |
| 68 | * @name Suffix Code | |
| 69 | */ | |
| 70 | public String getSuffixCode(); | |
| 71 | ||
| 72 | /** | |
| 73 | * A number that indicates the sequence or order of versions in | |
| 74 | * cases where several different Clus have the same offical | |
| 75 | * Identifier. | |
| 76 | * | |
| 77 | * @name Variation | |
| 78 | */ | |
| 79 | public String getVariation(); | |
| 80 | } |