001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
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 implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.framework.postprocessor;
017
018/**
019 * Returned from a {@link org.kuali.rice.kew.framework.postprocessor.PostProcessor} to indicate success of failure of
020 * a particular event.  If success is false then this will typically trigger
021 * the document to go into exception routing.
022 * 
023 * @see org.kuali.rice.kew.framework.postprocessor.PostProcessor
024 *
025 * @author Kuali Rice Team (rice.collab@kuali.org)
026 */
027public class ProcessDocReport implements java.io.Serializable {
028
029        static final long serialVersionUID = 376851530227478560L;
030
031        private boolean success = false;
032        private String message;
033        private Exception processException = null;
034
035        public ProcessDocReport(boolean success) {
036                this(success, "");
037        }
038
039        public ProcessDocReport(boolean success, String message) {
040                this.success = success;
041                this.message = message;
042        }
043
044        public ProcessDocReport(boolean success, String message, Exception e) {
045                this.success = success;
046                this.message = message;
047                this.processException = e;
048        }
049
050        public String getMessage() {
051                return message;
052        }
053
054        public Exception getProcessException() {
055                return processException;
056        }
057
058        public boolean isSuccess() {
059                return success;
060        }
061}