| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| LPRTransactionItem |
|
| 1.0;1 |
| 1 | package org.kuali.student.enrollment.lpr.infc; | |
| 2 | ||
| 3 | import java.util.List; | |
| 4 | ||
| 5 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 6 | ||
| 7 | /** | |
| 8 | * A transaction item represents a request for creating a new relation of a | |
| 9 | * person (student) to a LUI. The transaction item also handle removing, | |
| 10 | * updating, swapping out an old LUI for a new LUI for a person. | |
| 11 | * | |
| 12 | * @author Kuali Student Team (sambit) | |
| 13 | */ | |
| 14 | ||
| 15 | public interface LPRTransactionItem extends IdEntity { | |
| 16 | ||
| 17 | /** | |
| 18 | * The possible types of the LPR transaction item e.g. ADD, UPDATE, DROP, | |
| 19 | * SWAP | |
| 20 | * | |
| 21 | * @see org.kuali.student.r2.common.infc.HasType#getTypeKey() | |
| 22 | */ | |
| 23 | @Override | |
| 24 | public String getTypeKey(); | |
| 25 | ||
| 26 | /** | |
| 27 | * The possible states of the LPR transaction item e.g. DRAFT, SUBMITTED, | |
| 28 | * FAILED etc | |
| 29 | * | |
| 30 | * @see org.kuali.student.r2.common.infc.HasState#getStateKey() | |
| 31 | */ | |
| 32 | @Override | |
| 33 | public String getStateKey(); | |
| 34 | ||
| 35 | /** | |
| 36 | * The person id for the relation request. | |
| 37 | * | |
| 38 | * @return | |
| 39 | */ | |
| 40 | public String getPersonId(); | |
| 41 | ||
| 42 | /** | |
| 43 | * The LUI id for a new relation request. | |
| 44 | * | |
| 45 | * @return | |
| 46 | */ | |
| 47 | public String getNewLuiId(); | |
| 48 | ||
| 49 | /** | |
| 50 | * The existing LUI id for an existing relation remove or change requests. | |
| 51 | * | |
| 52 | * @return | |
| 53 | */ | |
| 54 | public String getExistingLuiId(); | |
| 55 | ||
| 56 | /** | |
| 57 | * Specify the various request (or registration ) options for creating this | |
| 58 | * relationship. | |
| 59 | * | |
| 60 | * @return | |
| 61 | */ | |
| 62 | public List<? extends RequestOption> getRequestOptions(); | |
| 63 | ||
| 64 | /** | |
| 65 | * Returns the transaction item result for this transaction item. | |
| 66 | * | |
| 67 | * @return | |
| 68 | */ | |
| 69 | public LprTransactionItemResult getLprTransactionItemResult(); | |
| 70 | ||
| 71 | /** | |
| 72 | * Specify the grading and credit options for the course. | |
| 73 | * | |
| 74 | * @return | |
| 75 | */ | |
| 76 | public List<String> getResultOptionKeys(); | |
| 77 | ||
| 78 | /** | |
| 79 | * The transaction item group id to link the LPR transaction items of the | |
| 80 | * related LUIs (if any) created as part of a single transaction item. | |
| 81 | * | |
| 82 | * @return | |
| 83 | */ | |
| 84 | public String getGroupId(); | |
| 85 | ||
| 86 | } |