KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > springframework > webflow > execution > FlowExecutionException


1 /*
2  * Copyright 2002-2006 the original author or authors.
3  *
4  * Licensed under the Apache 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.apache.org/licenses/LICENSE-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.springframework.webflow.execution;
17
18 import org.springframework.webflow.core.FlowException;
19
20 /**
21  * Base class for exceptions that occur within a flow while it is executing. Can
22  * be used directly, but you are encouraged to create a specific subclass for a
23  * particular use case.
24  * <p>
25  * Execution exceptions occur at runtime when the flow is executing requests on
26  * behalf of a client. They signal that an execution problem occured: e.g.
27  * action execution failed or no transition matched the current request context.
28  *
29  * @author Keith Donald
30  * @author Erwin Vervaet
31  */
32 public class FlowExecutionException extends FlowException {
33
34     /**
35      * The id of the flow definition in which the exception occured.
36      */
37     private String JavaDoc flowId;
38
39     /**
40      * The state of the flow where the exception occured (optional).
41      */
42     private String JavaDoc stateId;
43
44     /**
45      * Creates a new flow execution exception.
46      * @param flowId the flow where the exception occured
47      * @param stateId the state where the exception occured
48      * @param message a descriptive message
49      */
50     public FlowExecutionException(String JavaDoc flowId, String JavaDoc stateId, String JavaDoc message) {
51         super(message);
52         this.stateId = stateId;
53         this.flowId = flowId;
54     }
55
56     /**
57      * Creates a new flow execution exception.
58      * @param flowId the flow where the exception occured
59      * @param stateId the state where the exception occured
60      * @param message a descriptive message
61      * @param cause the root cause
62      */
63     public FlowExecutionException(String JavaDoc flowId, String JavaDoc stateId, String JavaDoc message, Throwable JavaDoc cause) {
64         super(message, cause);
65         this.stateId = stateId;
66         this.flowId = flowId;
67     }
68
69     /**
70      * Returns the id of the flow definition that was executing when this
71      * exception occured.
72      */
73     public String JavaDoc getFlowId() {
74         return flowId;
75     }
76
77     /**
78      * Returns the id of the state definition where the exception occured. Could
79      * be null if no state was active at the time when the exception was thrown.
80      */
81     public String JavaDoc getStateId() {
82         return stateId;
83     }
84 }
Popular Tags