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 implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.kuali.student.r2.common.infc;
18
19 /**
20 * Status object returned by bulk operations to indicate the status of each item
21 * within the bulk operation.
22 */
23
24 public interface BulkStatus {
25
26 /**
27 * Optional id of the created object
28 *
29 * @name id
30 * @readOnly
31 */
32 public String getId();
33
34 /**
35 * Indicates the success or failure of the operation.
36 *
37 * @name Success Indicator
38 * @readOnly
39 * @required
40 */
41 public Boolean getIsSuccess();
42
43 /**
44 * Optional message indicating a reason.
45 *
46 * @name Message
47 * @readOnly
48 */
49 public String getMessage();
50 }
51
52