| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| CluIdentifier |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2011 The Kuali Foundation Licensed under the | |
| 3 | * Educational Community License, Version 2.0 (the "License"); you may | |
| 4 | * not use this file except in compliance with the License. You may | |
| 5 | * obtain a copy of the License at | |
| 6 | * | |
| 7 | * http://www.osedu.org/licenses/ECL-2.0 | |
| 8 | * | |
| 9 | * Unless required by applicable law or agreed to in writing, | |
| 10 | * software distributed under the License is distributed on an "AS IS" | |
| 11 | * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express | |
| 12 | * or implied. See the License for the specific language governing | |
| 13 | * permissions and limitations under the License. | |
| 14 | */ | |
| 15 | ||
| 16 | package org.kuali.student.r2.lum.clu.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.IdNamelessEntity; | |
| 19 | ||
| 20 | /** | |
| 21 | * @Version 2.0 | |
| 22 | * @Author Sri komandur@uw.edu | |
| 23 | */ | |
| 24 | public interface CluIdentifier extends IdNamelessEntity { | |
| 25 | /** | |
| 26 | * The composite string that is used to officially reference or publish the | |
| 27 | * CLU. Note it may have an internal structure that each Institution may | |
| 28 | * want to enforce. This structure may be composed from the other parts of | |
| 29 | * the structure such as Level amp; Division, but may include items such as | |
| 30 | * cluType. | |
| 31 | * | |
| 32 | * @name Code | |
| 33 | */ | |
| 34 | public String getCode(); | |
| 35 | ||
| 36 | /** | |
| 37 | * Abbreviated name of the CLU, commonly used on transcripts | |
| 38 | * | |
| 39 | * @name Short Name | |
| 40 | */ | |
| 41 | public String getShortName(); | |
| 42 | ||
| 43 | /** | |
| 44 | * Descriptive name of the CLU | |
| 45 | * | |
| 46 | * @name Long Name | |
| 47 | */ | |
| 48 | public String getLongName(); | |
| 49 | ||
| 50 | /** | |
| 51 | * A code that indicates whether this is introductory, advanced, etc. | |
| 52 | * | |
| 53 | * @name Level | |
| 54 | */ | |
| 55 | public String getLevel(); | |
| 56 | ||
| 57 | /** | |
| 58 | * A code that indicates what school, program, major, subject area, etc. | |
| 59 | * Examples: "Chem", "18" | |
| 60 | * | |
| 61 | * @name Division | |
| 62 | */ | |
| 63 | public String getDivision(); | |
| 64 | ||
| 65 | /* | |
| 66 | * The "extra" portion of the code, which usually corresponds with the most detailed part of the number. | |
| 67 | * @name Suffix Code | |
| 68 | */ | |
| 69 | public String getSuffixCode(); | |
| 70 | ||
| 71 | /** | |
| 72 | * A number that indicates the sequence or order of versions in cases where | |
| 73 | * several different Clus have the same offical Identifier | |
| 74 | * | |
| 75 | * @name Variation | |
| 76 | */ | |
| 77 | public String getVariation(); | |
| 78 | ||
| 79 | /* | |
| 80 | * The identifier of the organization associated with this cluIdentifier. | |
| 81 | * @name Org Id | |
| 82 | * @readOnly | |
| 83 | */ | |
| 84 | public String getOrgId(); | |
| 85 | } |