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 package org.kuali.student.enrollment.courseofferingset.infc;
17
18 import java.util.List;
19 import org.kuali.student.r2.common.infc.IdNamelessEntity;
20 import org.kuali.student.r2.common.infc.RichText;
21
22 /**
23 * Read only object that holds the results of a rollover process
24 *
25 * @author nwright
26 */
27 public interface SocRolloverResultItem
28 extends IdNamelessEntity {
29
30 /**
31 * The id of the rollover result to which this item belongs
32 *
33 * @name Soc Rollover Result Id
34 * @readOnly
35 * @required
36 * @impl set during the #rolloverSoc operation
37 */
38 public String getSocRolloverResultId();
39
40 /**
41 * The id of the source course offering
42 *
43 * @name Source Course Offering Id
44 * @readOnly
45 * @required
46 * @impl set during the #rolloverSoc operation
47 */
48 public String getSourceCourseOfferingId();
49
50 /**
51 * The id of the target course offering
52 *
53 * Can be null if the rollover did not rollover the source course offering.
54 *
55 * @name Source Course Offering Id
56 * @readOnly
57 * @impl set during the #rolloverSoc operation
58 */
59 public String getTargetCourseOfferingId();
60
61 /**
62 * Messages describing details of the status.
63 *
64 * Often left null if the status is that it is complete.
65 *
66 * @name Message
67 * @readOnly
68 * @impl set during the #rolloverSoc operation
69 */
70 public RichText getMessage();
71 }