| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| RefDocRelation |
|
| 1.0;1 |
| 1 | package org.kuali.student.r2.core.document.infc; | |
| 2 | ||
| 3 | import org.kuali.student.r2.common.infc.Relationship; | |
| 4 | import org.kuali.student.r2.common.infc.RichText; | |
| 5 | ||
| 6 | /** | |
| 7 | * Information about the object to document relation. | |
| 8 | * | |
| 9 | * @Version 2.0 | |
| 10 | * @Author Sri komandur@uw.edu | |
| 11 | * | |
| 12 | */ | |
| 13 | public interface RefDocRelation extends Relationship { | |
| 14 | /** | |
| 15 | * Unique identifier for an object type. Used to identify the type of | |
| 16 | * object being referred to, so that the id can be resolved. | |
| 17 | * | |
| 18 | * @name Ref Object Type Key | |
| 19 | * @readOnly | |
| 20 | * @required | |
| 21 | * | |
| 22 | */ | |
| 23 | public String getRefObjectTypeKey(); | |
| 24 | ||
| 25 | /** | |
| 26 | * Identifier for an object. This will likely require some additional | |
| 27 | * context in order to be resolved, such as the type of object. An objectId | |
| 28 | * could be a cluId, a luiId, an orgId, a documentId, etc. | |
| 29 | * | |
| 30 | * @name Ref Object Id | |
| 31 | * @readOnly | |
| 32 | * @required | |
| 33 | * | |
| 34 | */ | |
| 35 | public String getRefObjectId(); | |
| 36 | ||
| 37 | /** | |
| 38 | * Unique identifier for a document. | |
| 39 | * | |
| 40 | * @name Document Id | |
| 41 | * @readOnly | |
| 42 | * @required | |
| 43 | * | |
| 44 | */ | |
| 45 | public String getDocumentId(); | |
| 46 | ||
| 47 | /** | |
| 48 | * The title of the document usage in the context of the relation to the | |
| 49 | * object. | |
| 50 | * | |
| 51 | * @name Title | |
| 52 | * | |
| 53 | */ | |
| 54 | public String getTitle(); | |
| 55 | ||
| 56 | /** | |
| 57 | * The description of the document usage in the context of the relation to the | |
| 58 | * object. | |
| 59 | * | |
| 60 | * @name Description | |
| 61 | * | |
| 62 | */ | |
| 63 | public RichText getDescr (); | |
| 64 | } |