View Javadoc

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 btain 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  
17  package org.kuali.student.r2.common.infc;
18  
19  import java.util.List;
20  
21  /**
22   * Represents the status information for a transactional operation.
23   * 
24   * @author Kuali Student Team (sambit)
25   */
26  
27  public interface OperationStatus {
28  
29      /**
30       * Gets the operation status for the transaction.
31       * 
32       * @name Status
33       */
34      public String getStatus();
35  
36      /**
37       * Gets the informational message as a result of this transaction.
38       * 
39       * @name Messages
40       */
41  
42      public List<String> getMessages();
43  
44      /**
45       * Returns the warning messages for this transaction. Returns an
46       * empty list if there are no warnings.
47       * 
48       * @name Warnings
49       */
50      public List<String> getWarnings();
51  
52      /**
53       * Returns the error messages for this transaction. Returns an
54       * empty list if there are no errors.
55       * 
56       * @name Errors
57       */
58      public List<String> getErrors();
59  }