001    /*
002     * Copyright 2011 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the
005     * "License"); you may not use this file except in compliance with the
006     * License.  You may btain a copy of the License at
007     *
008     *      http://www.osedu.org/licenses/ECL-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
013     * implied.  See the License for the specific language governing
014     * permissions and limitations under the License.
015     */
016    
017    package org.kuali.student.r2.common.infc;
018    
019    import java.util.List;
020    
021    /**
022     * Represents the status information for a transactional operation.
023     * 
024     * @author Kuali Student Team (sambit)
025     */
026    
027    public interface OperationStatus {
028    
029        /**
030         * Gets the operation status for the transaction.
031         * 
032         * @name Status
033         */
034        public String getStatus();
035    
036        /**
037         * Gets the informational message as a result of this transaction.
038         * 
039         * @name Messages
040         */
041    
042        public List<String> getMessages();
043    
044        /**
045         * Returns the warning messages for this transaction. Returns an
046         * empty list if there are no warnings.
047         * 
048         * @name Warnings
049         */
050        public List<String> getWarnings();
051    
052        /**
053         * Returns the error messages for this transaction. Returns an
054         * empty list if there are no errors.
055         * 
056         * @name Errors
057         */
058        public List<String> getErrors();
059    }