| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Lui |
|
| 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.HasEffectiveDates; | |
| 22 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 23 | import org.kuali.student.r2.common.infc.MeetingSchedule; | |
| 24 | import org.kuali.student.r2.lum.clu.infc.Expenditure; | |
| 25 | import org.kuali.student.r2.lum.clu.infc.Fee; | |
| 26 | import org.kuali.student.r2.lum.clu.infc.LuCode; | |
| 27 | import org.kuali.student.r2.lum.clu.infc.Revenue; | |
| 28 | ||
| 29 | /** | |
| 30 | * Detailed information about a single LUI. | |
| 31 | */ | |
| 32 | public interface Lui | |
| 33 | extends IdEntity, HasEffectiveDates { | |
| 34 | ||
| 35 | /** | |
| 36 | * The LUI identifier. | |
| 37 | * | |
| 38 | * @name: Lui Identifier | |
| 39 | */ | |
| 40 | public LuiIdentifier getOfficialIdentifier(); | |
| 41 | ||
| 42 | /** | |
| 43 | * The alternate LUI identifiers. | |
| 44 | * | |
| 45 | * @name: Lui Alternate Identifiers | |
| 46 | */ | |
| 47 | public List<? extends LuiIdentifier> getAlternateIdentifiers(); | |
| 48 | ||
| 49 | /** | |
| 50 | * The unique identifier for the Canonical Learning Unit | |
| 51 | * (CLU) of which this is an instance. | |
| 52 | * | |
| 53 | * @name Clu Id | |
| 54 | * @readonly | |
| 55 | * @required | |
| 56 | */ | |
| 57 | public String getCluId(); | |
| 58 | ||
| 59 | /** | |
| 60 | * Any Clu Clu Relation identifiers on which this instance is | |
| 61 | * based. While the LUI is in instance of a CLU, the LUI may be an | |
| 62 | * instance of a set of CLUs related to the principal CLU, such as | |
| 63 | * a Course Format. | |
| 64 | * | |
| 65 | * @name Clu Clu Relation Ids | |
| 66 | */ | |
| 67 | public List<String> getCluCluRelationIds(); | |
| 68 | ||
| 69 | /** | |
| 70 | * The unique identifier for the Academic Time Period (ATP) | |
| 71 | * for which this instance is offered. | |
| 72 | * | |
| 73 | * @name Atp Id | |
| 74 | * @readonly | |
| 75 | * @required | |
| 76 | */ | |
| 77 | public String getAtpId(); | |
| 78 | ||
| 79 | /** | |
| 80 | * Places where this LUI is offered. This is a temporary field | |
| 81 | * that parallels the campus enumeration in CLU. It may evolve | |
| 82 | * into a list of Campus Ids when we work that out. | |
| 83 | * | |
| 84 | * @name Campus Location Keys | |
| 85 | */ | |
| 86 | public List<String> getCampusLocations(); | |
| 87 | ||
| 88 | /** | |
| 89 | * The Schedule Id. | |
| 90 | * | |
| 91 | * @name Schedule Id | |
| 92 | */ | |
| 93 | public String getScheduleId(); | |
| 94 | ||
| 95 | /** | |
| 96 | * List of LU code info structures. These are structures so that | |
| 97 | * many different types of codes can be associated with the | |
| 98 | * clu. This allows them to be put into categories. | |
| 99 | * | |
| 100 | * @name codes | |
| 101 | */ | |
| 102 | public List<? extends LuCode> getLuiCodes(); | |
| 103 | ||
| 104 | /** | |
| 105 | * The total maximum number of "seats" or enrollment slots that | |
| 106 | * can be filled for the lui. | |
| 107 | * | |
| 108 | * @name Maximum Enrollment | |
| 109 | */ | |
| 110 | public Integer getMaximumEnrollment(); | |
| 111 | ||
| 112 | /** | |
| 113 | * Total minimum number of seats that must be filled for the lui. | |
| 114 | * | |
| 115 | * @name Minimum Enrollment | |
| 116 | */ | |
| 117 | public Integer getMinimumEnrollment(); | |
| 118 | ||
| 119 | /** | |
| 120 | * The reference URL for this LUI. | |
| 121 | * | |
| 122 | * @name referenceURL | |
| 123 | */ | |
| 124 | public String getReferenceURL(); | |
| 125 | ||
| 126 | /** | |
| 127 | * Identifiers for Organization(s) that is responsible for the delivery - and all | |
| 128 | * associated logistics - of the Lui. | |
| 129 | * | |
| 130 | * @name Units Deployment Org Id | |
| 131 | */ | |
| 132 | public List<String> getUnitsDeployment(); | |
| 133 | ||
| 134 | /** | |
| 135 | * Identifiers for Organization(s) that is responsible for the academic content of | |
| 136 | * the Lui as approved in its canonical form. | |
| 137 | * | |
| 138 | * @name Units Content Owner Org Id | |
| 139 | */ | |
| 140 | public List<String> getUnitsContentOwner(); | |
| 141 | ||
| 142 | /** | |
| 143 | * The options/scales that indicate the allowable grades that can | |
| 144 | * be awarded or credits applied. | |
| 145 | * | |
| 146 | * If the value is set here then the Clu must have a | |
| 147 | * grading option or credit options set on the canonical activity. | |
| 148 | * | |
| 149 | * ResultValuesGroup will contain grade values valid for this | |
| 150 | * course offering. | |
| 151 | * | |
| 152 | * @name: Result Values Group Ids | |
| 153 | */ | |
| 154 | public List<String> getResultValuesGroupKeys(); | |
| 155 | ||
| 156 | /** | |
| 157 | * These are the related lui types which may be related to this lui, e.g., activty | |
| 158 | * offering types to format offering | |
| 159 | * | |
| 160 | * @name Related Lui Types | |
| 161 | */ | |
| 162 | public List<String> getRelatedLuiTypes(); | |
| 163 | } |