View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.common.messagebuilder.booleanmessage;
17  
18  public interface BooleanMessage {
19  	/**
20  	 * Gets the message id.
21  	 * 
22  	 * @return Message id
23  	 */
24  	public String getMessageId();
25  
26  	/**
27  	 * Returns whether the message is a success or failure.
28  	 * 
29  	 * @return True if successful; otherwise false
30  	 */
31  	public Boolean isSuccesful();
32  
33  	/**
34  	 * Returns either the success or failure message.
35  	 * 
36  	 *  @return Success or failure message
37  	 */
38  	public String getMessage();
39  }