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 operations to indicate that the operation
21 * succeeded.
22 *
23 * Note: The success is always TRUE otherwise the method should have
24 * thrown an exception.
25 *
26 * Used for delete operations because they have nothing to return
27 * otherwise and the standard is that all methods return something.
28 *
29 * TODO: switch this to hold a count or something, a boolean that
30 * always is true is confusing.
31 *
32 * TODO: Figure out where the message came from because it is not in
33 * the R1 wiki
34 * https://wiki.kuali.org/display/KULSTU/statusInfo+Structure
35 *
36 * @author nwright
37 */
38
39 public interface Status {
40
41 /**
42 * Indicates the success or failure of the operation.
43 *
44 * @name Success Indicator
45 * @readOnly
46 * @required
47 */
48 public Boolean getIsSuccess();
49
50 /**
51 * Optional message indicating a reason.
52 *
53 * @name Message
54 * @readOnly
55 */
56 public String getMessage();
57 }
58