| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Org |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2010 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.r2.core.organization.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.IdNamelessEntity; | |
| 23 | import org.kuali.student.r2.common.infc.RichText; | |
| 24 | ||
| 25 | /** | |
| 26 | * Information about a single organization. | |
| 27 | * | |
| 28 | * Changes: LongName and LongDesc are the standard Name and Desc. | |
| 29 | * | |
| 30 | * @author tom | |
| 31 | */ | |
| 32 | ||
| 33 | public interface Org | |
| 34 | extends IdNamelessEntity, HasEffectiveDates { | |
| 35 | ||
| 36 | /** | |
| 37 | * Full name of the organization. | |
| 38 | * | |
| 39 | * @name Long Name | |
| 40 | * @required | |
| 41 | */ | |
| 42 | public String getLongName(); | |
| 43 | ||
| 44 | /** | |
| 45 | * Shortened format or abbreviation of the organization's name. | |
| 46 | * | |
| 47 | * @name Short Name | |
| 48 | */ | |
| 49 | public String getShortName(); | |
| 50 | ||
| 51 | /** | |
| 52 | * The name used for sorting, for cases when alphabetical sorting | |
| 53 | * by shortName or longName is undesirable. | |
| 54 | * | |
| 55 | * @name Sort Name | |
| 56 | * @required | |
| 57 | */ | |
| 58 | public String getSortName(); | |
| 59 | ||
| 60 | /** | |
| 61 | * Narrative description of the organization. | |
| 62 | * | |
| 63 | * @name Short Description | |
| 64 | */ | |
| 65 | public RichText getLongDescr(); | |
| 66 | ||
| 67 | /** | |
| 68 | * A brief description of the organization. | |
| 69 | * | |
| 70 | * @name Short Description | |
| 71 | */ | |
| 72 | public RichText getShortDescr(); | |
| 73 | ||
| 74 | /** | |
| 75 | * A list of organization code info structures. These are | |
| 76 | * structures so that many different types of codes can be | |
| 77 | * associated with the org. This allows them to be put into | |
| 78 | * categories. | |
| 79 | * | |
| 80 | * @name Org Codes | |
| 81 | * @required | |
| 82 | */ | |
| 83 | public List<? extends OrgCode> getOrgCodes(); | |
| 84 | } |