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 java.util.List;
20
21 import org.kuali.student.r2.common.infc.OperationStatus;
22
23 public interface RegistrationResponse {
24
25 /**
26 * The Registration Request Id.
27 *
28 * @name Registration Request Id
29 * @readOnly
30 * @required
31 */
32 public String getRegistrationRequestId();
33
34 /**
35 * The registration submission error status.
36 *
37 * If false, the registration was successful resulting in a
38 * CourseRegistration or a Waitlist entry.
39 *
40 * If the registration submission failed, and no
41 * CourseRegistrations or Waitlist entries resulted from the
42 * transaction.
43 *
44 * @name Has Failed Status
45 */
46 public Boolean getHasFailed();
47
48 /**
49 * The registration submission messages.
50 *
51 * Returns a list of status messages, typically in failure, from a
52 * registration submission.
53 *
54 * @name Registration Messages
55 */
56 public List<String> getMessages();
57
58 /**
59 * The individual registration response items.
60 *
61 * @name Registration Response Items
62 */
63 public List<? extends RegistrationResponseItem> getRegistrationResponseItems();
64 }