| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| CluSet |
|
| 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.HasEffectiveDates; | |
| 19 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 20 | ||
| 21 | import java.util.List; | |
| 22 | ||
| 23 | /** | |
| 24 | * Detailed information about a single CLU Set. | |
| 25 | * | |
| 26 | * @Version 2.0 | |
| 27 | * @Author Sri komandur@uw.edu | |
| 28 | */ | |
| 29 | public interface CluSet extends IdEntity, HasEffectiveDates { | |
| 30 | ||
| 31 | /** | |
| 32 | * List of identifiers of directly contained CLU Sets. Present for | |
| 33 | * enumerated CLU Sets. | |
| 34 | * | |
| 35 | * @name Clu Set Ids | |
| 36 | * @readOnly | |
| 37 | */ | |
| 38 | public List<String> getCluSetIds(); | |
| 39 | ||
| 40 | /** | |
| 41 | * List of identifiers of directly contained CLUs. Present for enumerated | |
| 42 | * CLU Sets. | |
| 43 | * | |
| 44 | * @name Clu Ids | |
| 45 | * @readOnly | |
| 46 | */ | |
| 47 | public List<String> getCluIds(); | |
| 48 | ||
| 49 | /** | |
| 50 | * Specifies a search for CLU identifiers. Present for dynamic CLU Sets | |
| 51 | * | |
| 52 | * @name Membership Query | |
| 53 | */ | |
| 54 | public MembershipQuery getMembershipQuery(); | |
| 55 | ||
| 56 | /** | |
| 57 | * Information about an organization acting in administrative capacity for a | |
| 58 | * learning unit.The Organization responsible for this cluset | |
| 59 | * | |
| 60 | * @name Admin Org | |
| 61 | */ | |
| 62 | public String getAdminOrg(); | |
| 63 | ||
| 64 | /** | |
| 65 | * Flags if the Clu Set is reusable or was created for one time use for e.g. | |
| 66 | * in ReqComponentInfo | |
| 67 | * | |
| 68 | * @name Is Reusable | |
| 69 | */ | |
| 70 | public Boolean getIsReusable(); | |
| 71 | ||
| 72 | /** | |
| 73 | * Flags set to true if CluSet can be referenced by ReqComponets and other | |
| 74 | * entities. If set to false, then the CluSet can be referenced only by | |
| 75 | * other CluSets. | |
| 76 | * | |
| 77 | * @name Is Referenceable | |
| 78 | */ | |
| 79 | public Boolean getIsReferenceable(); | |
| 80 | ||
| 81 | } |