| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Proposal |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2010 The Kuali Foundation Licensed under the Educational Community | |
| 3 | * License, Version 2.0 (the "License"); you may not use this file except in | |
| 4 | * compliance with the License. You may obtain a copy of the License at | |
| 5 | * http://www.osedu.org/licenses/ECL-2.0 Unless required by applicable law or | |
| 6 | * agreed to in writing, software distributed under the License is distributed | |
| 7 | * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | |
| 8 | * express or implied. See the License for the specific language governing | |
| 9 | * permissions and limitations under the License. | |
| 10 | */ | |
| 11 | ||
| 12 | package org.kuali.student.r2.core.proposal.infc; | |
| 13 | ||
| 14 | import java.util.Date; | |
| 15 | import java.util.List; | |
| 16 | ||
| 17 | import javax.xml.bind.annotation.XmlAccessType; | |
| 18 | import javax.xml.bind.annotation.XmlAccessorType; | |
| 19 | ||
| 20 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 21 | import org.kuali.student.r2.common.infc.RichText; | |
| 22 | ||
| 23 | /** | |
| 24 | * Detailed information about a proposal. | |
| 25 | * | |
| 26 | * @author Kuali Student Team (sambitpa@kuali.org) | |
| 27 | */ | |
| 28 | @XmlAccessorType(XmlAccessType.FIELD) | |
| 29 | public interface Proposal extends IdEntity { | |
| 30 | ||
| 31 | /** | |
| 32 | * List of person identifiers. Structure should contain a proposerPerson OR | |
| 33 | * a proposerOrg. | |
| 34 | */ | |
| 35 | public List<String> getProposerPerson(); | |
| 36 | ||
| 37 | /** | |
| 38 | * List of organization identifiers. Structure should contain a | |
| 39 | * proposerPerson OR a proposerOrg | |
| 40 | */ | |
| 41 | public List<String> getProposerOrg(); | |
| 42 | ||
| 43 | /** | |
| 44 | * Unique identifier for a reference type. | |
| 45 | */ | |
| 46 | public String getProposalReferenceType(); | |
| 47 | ||
| 48 | /** | |
| 49 | * List of reference identifiers. | |
| 50 | */ | |
| 51 | public List<String> getProposalReference(); | |
| 52 | ||
| 53 | /** | |
| 54 | * Brief explanation of the reason for the proposal | |
| 55 | */ | |
| 56 | public RichText getRationale(); | |
| 57 | ||
| 58 | /** | |
| 59 | * Date and time that this proposal became effective. This is a similar | |
| 60 | * concept to the effective date on enumerated values. When an expiration | |
| 61 | * date has been specified, this field must be less than or equal to the | |
| 62 | * expiration date. | |
| 63 | */ | |
| 64 | public Date getEffectiveDate(); | |
| 65 | ||
| 66 | /** | |
| 67 | * Date and time that this proposal expires. This is a similar concept to | |
| 68 | * the expiration date on enumerated values. If specified, this should be | |
| 69 | * greater than or equal to the effective date. If this field is not | |
| 70 | * specified, then no expiration date has been currently defined and should | |
| 71 | * automatically be considered greater than the effective date. | |
| 72 | */ | |
| 73 | public Date getExpirationDate(); | |
| 74 | ||
| 75 | /** | |
| 76 | * The workflow document associated with this proposal. | |
| 77 | * | |
| 78 | * @return | |
| 79 | */ | |
| 80 | public String getWorkflowId(); | |
| 81 | ||
| 82 | } |