| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Population |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2011 The Kuali Foundation Licensed under the Educational | |
| 3 | * Community License, Version 2.0 (the "License"); you may not use | |
| 4 | * this file except in compliance with the License. You may obtain a | |
| 5 | * 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, software | |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 12 | * implied. See the License for the specific language governing | |
| 13 | * permissions and limitations under the License. | |
| 14 | */ | |
| 15 | ||
| 16 | package org.kuali.student.r2.core.population.infc; | |
| 17 | ||
| 18 | import java.util.List; | |
| 19 | ||
| 20 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 21 | ||
| 22 | ||
| 23 | /** | |
| 24 | * Information about a Population. | |
| 25 | * | |
| 26 | * @author tom | |
| 27 | * @since Thu Nov 21 14:22:34 EDT 2011 | |
| 28 | */ | |
| 29 | ||
| 30 | public interface Population extends IdEntity { | |
| 31 | ||
| 32 | /** | |
| 33 | * Gets the valid sort order keys that can be used to sort the | |
| 34 | * members of the Population. | |
| 35 | * | |
| 36 | * The valid sort order keys correspond | |
| 37 | * to the underlying rule sorting capabilities. | |
| 38 | * | |
| 39 | * This may return an empty list indicating the population does not support | |
| 40 | * any particular ordering. | |
| 41 | * | |
| 42 | * @name Sort Order Type Keys | |
| 43 | * @readOnly calculation surfacing the corresponding field from the underlying rule | |
| 44 | */ | |
| 45 | public List<String> getSortOrderTypeKeys(); | |
| 46 | ||
| 47 | /** | |
| 48 | * Tests to see if the Population may vary by time. | |
| 49 | * | |
| 50 | * If true then the response to isMemberAtXXXX getMembersAtXXXX methods should | |
| 51 | * be used to assess membership because it is highly likely the population | |
| 52 | * would return a different result depending on the time parameter that is supplied. | |
| 53 | * | |
| 54 | * An example of populations that vary by time include freshman, sophomore, | |
| 55 | * junior, senior, etc... because the answer varies greatly depending on the | |
| 56 | * term in question. | |
| 57 | * | |
| 58 | * Some examples of populations that are not expected to vary with time are | |
| 59 | * males or students with IDs ending in an odd number or US citizens. | |
| 60 | * | |
| 61 | * Note: Saying that a population does not vary with time does not mean that | |
| 62 | * the population does not change over time. Rather it means that | |
| 63 | * calls isMember and isMemberAtXXX methods or getMembers and getMembersAtXXX | |
| 64 | * should normally return the same answer if invoked simultaneously. | |
| 65 | * | |
| 66 | * @name Varies By Time | |
| 67 | * @readOnly calculation surfacing the corresponding field from the underlying rule | |
| 68 | */ | |
| 69 | public Boolean getVariesByTime(); | |
| 70 | ||
| 71 | /** | |
| 72 | * Tests to see if this Population supports the getting of an explicit list | |
| 73 | * of the members in this population. | |
| 74 | * | |
| 75 | * Not all populations need to support this method and only support | |
| 76 | * the isMember method which tests. | |
| 77 | * | |
| 78 | * If false then calls to the getMembersXXX family for this population | |
| 79 | * should throw an OperationFailedException exception. | |
| 80 | * | |
| 81 | * @name Supports Get Members | |
| 82 | * @readOnly calculation surfacing the corresponding field from the underlying rule | |
| 83 | */ | |
| 84 | public Boolean getSupportsGetMembers(); | |
| 85 | ||
| 86 | } |