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.batchjobresults.infc;
17
18 import org.kuali.student.r2.common.infc.IdNamelessEntity;
19 import org.kuali.student.r2.common.infc.RichText;
20
21 /**
22 * Object that holds individual item results of a batch job
23 *
24 * @author nwright
25 */
26 public interface BatchJobResultItem
27 extends IdNamelessEntity {
28 /**
29 * The id of the batch job result to which this is attached
30 *
31 * @name Batch Job Result Id
32 */
33 public String getBatchJobResultId();
34
35 /**
36 * The id of the source object being processed
37 *
38 * The kind of object being processed depends on the type of the batch job.
39 *
40 * @name Source Id
41 */
42 public String getSourceId();
43
44 /**
45 * The id of the target object being created or processed
46 *
47 * TODO: WORRY ABOUT SITUATIONS THAT ARE NOT ONE FOR ONE
48 *
49 * @name Target Id
50 */
51 public String getTargetId();
52
53 /**
54 * Messages describing details of the status.
55 *
56 * Often left null if the status is that it is complete or successful.
57 *
58 * @name Message
59 */
60 public RichText getMessage();
61 }