| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Comment |
|
| 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.core.comment.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.IdNamelessEntity; | |
| 19 | import org.kuali.student.r2.common.infc.RichText; | |
| 20 | ||
| 21 | import java.util.Date; | |
| 22 | ||
| 23 | /** | |
| 24 | * Comments associated with other objects in the system | |
| 25 | * | |
| 26 | * @Version 2.0 | |
| 27 | * @Author Sri komandur@uw.edu | |
| 28 | */ | |
| 29 | public interface Comment extends IdNamelessEntity { | |
| 30 | /** | |
| 31 | * Narrative text of the comment | |
| 32 | * | |
| 33 | * @name Comment Text | |
| 34 | * @required | |
| 35 | */ | |
| 36 | public RichText getCommentText(); | |
| 37 | ||
| 38 | /** | |
| 39 | * Unique identifier for a reference type. | |
| 40 | * | |
| 41 | * @name Reference Type Key | |
| 42 | * @readOnly | |
| 43 | * @required | |
| 44 | */ | |
| 45 | public String getReferenceTypeKey(); | |
| 46 | ||
| 47 | /** | |
| 48 | * Identifier component for a reference. This is an external identifier and such may not uniquely identify | |
| 49 | * a particular reference unless combined with the type. A referenceId could be a cluId, a luiId, | |
| 50 | * an orgId, a documentId, etc. | |
| 51 | * | |
| 52 | * @name Reference Id | |
| 53 | * @readOnly | |
| 54 | * @required | |
| 55 | */ | |
| 56 | public String getReferenceId(); | |
| 57 | ||
| 58 | /** | |
| 59 | * Date and time that this comment became effective. This is a similar concept to the effective date on | |
| 60 | * enumerated values. When an expiration date has been specified, this field must be less than or equal | |
| 61 | * to the expiration date. | |
| 62 | * | |
| 63 | * @name Effective Date | |
| 64 | */ | |
| 65 | public Date getEffectiveDate(); | |
| 66 | ||
| 67 | /** | |
| 68 | * Date and time that this comment expires. This is a similar concept to the expiration date on | |
| 69 | * enumerated values. If specified, this should be greater than or equal to the effective date. If this field | |
| 70 | * is not specified, then no expiration date has been currently defined and should automatically be considered | |
| 71 | * greater than the effective date. | |
| 72 | * | |
| 73 | * @name Expiration Date | |
| 74 | */ | |
| 75 | public Date getExpirationDate(); | |
| 76 | ||
| 77 | } |