1 /*
2 * Copyright 2011 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.courseregistration.infc;
18
19 import org.kuali.student.r2.common.infc.HasAttributesAndMeta;
20 import org.kuali.student.r2.common.infc.OperationStatus;
21
22 /**
23 * A response to an individual RegistrationRequestItem. A response
24 * may result in a CourseRegistration or a position on a course
25 * waitlist, or just return the error messages.
26 *
27 * @author Kuali Student Team (sambit)
28 */
29
30 public interface RegistrationResponseItem {
31
32 /**
33 * Gets the RegistrationRequestItem to which this item is a
34 * response.
35 *
36 * @name Registration Request Item
37 * @readOnly
38 * @required
39 */
40 public String getRegistrationRequestItemId();
41
42 /// ??????
43 /**
44 * Get the operation status info for the registration item.
45 *
46 * @name Operation Status
47 */
48 public OperationStatus getOperationStatus();
49
50
51 // separate field for waitlists status
52
53 // separate field for aync posting/??
54
55
56 /**
57 * Gets the course registration (if any) that resulted from this
58 * registration transaction.
59 *
60 * @name Course Registration Id
61 */
62 public String getCourseRegistrationId();
63
64 /**
65 * Gets the waitlist entry (if any) that resulted from this
66 * registration transaction.
67 *
68 * @name Course Waitlist Entry Id
69 */
70 public String getCourseWaitlistEntryId();
71
72 /**
73 * Gets the hold until list entry (if any) that resulted from this
74 * registration transaction.
75 *
76 * @name Hold Until List Entry Id
77 */
78 public String getHoldUntilListEntryId();
79 }