1 /*
2 * Copyright 2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * 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 package org.kuali.student.contract.model.test.source;
17
18 /**
19 * Status object returned by operations to indicate that the operation succeeded
20 *
21 * Note: The success is always TRUE otherwise the method should have thrown an exception.
22 *
23 * Used for delete operations because they have nothing to return otherwise and the
24 * standard is that all methods return something.
25 *
26 * TODO: switch this to hold a count or something, a boolean that always is true is confusing.
27 * TODO: Figure out where the message came from because it is not in the R1 wiki
28 * https://wiki.kuali.org/display/KULSTU/statusInfo+Structure
29 *
30 * @author nwright
31 */
32 public interface Status {
33
34 /**
35 * Name: Success Indicator
36 *
37 * Indicates the success or failure of the operation
38 */
39 public Boolean isSuccess();
40
41 /**
42 * Name: Message
43 *
44 * Optional message indicating a reason
45 */
46 public String getMessage();
47 }
48