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.enrollment.lpr.infc;
18
19 import java.util.List;
20
21 import org.kuali.student.r2.common.infc.IdEntity;
22
23 /**
24 * The LprTransaction represents an object to capture an overall
25 * transaction request. The requesting person ID is the person who creates this
26 * overall request. There are multiple transaction items,
27 * {@link LprTransactionItem}, in a single overall transaction.
28 *
29 * @author Kuali Student Team (sambit)
30 */
31
32 public interface LprTransaction extends IdEntity {
33
34 /**
35 * The person who requested for this transaction
36 *
37 * Note this does not have to be the same as the person on the transaction
38 * item. It could be, for example, an administrator creating registrations
39 * on behalf of the student.
40 *
41 * @name Requesting Person Id
42 */
43 public String getRequestingPersonId();
44
45 /**
46 * The ATP for which this transaction applies.
47 *
48 * This constrains which lui's can be manipulated by this transaction's items.
49 * The items may only refer to this ATP or nested ATPs.
50 *
51 * @name ATP Id
52 */
53 public String getAtpId();
54
55 /**
56 * Transaction item for this
57 *
58 * @name LPR Transaction Items
59 */
60 List<? extends LprTransactionItem> getLprTransactionItems();
61 }