KickJava   Java API By Example, From Geeks To Geeks.

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


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.core.enums.StaticLabeledEnum;
19
20 /**
21  * Type-safe enumeration of possible flow session statuses. Consult the
22  * JavaDoc for the {@link FlowSession} for more information on how these
23  * statuses are used during the life cycle of a flow session.
24  *
25  * @see org.springframework.webflow.execution.FlowSession
26  *
27  * @author Keith Donald
28  * @author Erwin Vervaet
29  */
30 public class FlowSessionStatus extends StaticLabeledEnum {
31
32     /**
33      * Initial status of a flow session; the session has been created but not
34      * yet activated.
35      */
36     public static FlowSessionStatus CREATED = new FlowSessionStatus(0, "Created");
37
38     /**
39      * A flow session with STARTING status is about to enter its start state.
40      */
41     public static FlowSessionStatus STARTING = new FlowSessionStatus(1, "Starting");
42
43     /**
44      * A flow session with ACTIVE status is currently executing.
45      */
46     public static FlowSessionStatus ACTIVE = new FlowSessionStatus(2, "Active");
47
48     /**
49      * A flow session with PAUSED status is currently waiting on the user to
50      * signal an event.
51      */
52     public static FlowSessionStatus PAUSED = new FlowSessionStatus(3, "Paused");
53
54     /**
55      * A flow session that is SUSPENDED is not actively executing a flow. It is
56      * waiting for subflow execution to complete before continuing.
57      */
58     public static FlowSessionStatus SUSPENDED = new FlowSessionStatus(4, "Suspended");
59
60     /**
61      * A flow session that has ENDED is no longer actively executing a flow.
62      * This is the final status of a flow session.
63      */
64     public static FlowSessionStatus ENDED = new FlowSessionStatus(5, "Ended");
65
66     /**
67      * Private constructor because this is a typesafe enum!
68      */
69     private FlowSessionStatus(int code, String JavaDoc label) {
70         super(code, label);
71     }
72 }
Popular Tags