All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.webflow.execution.FlowSessionStatus Maven / Gradle / Ivy

There is a newer version: 1.0.6
Show newest version
/*
 * Copyright 2004-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.webflow.execution;

import org.springframework.core.enums.StaticLabeledEnum;

/**
 * Type-safe enumeration of possible flow session statuses. Consult the JavaDoc for the {@link FlowSession} for more
 * information on how these statuses are used during the life cycle of a flow session.
 * 
 * @see org.springframework.webflow.execution.FlowSession
 * 
 * @author Keith Donald
 * @author Erwin Vervaet
 */
public class FlowSessionStatus extends StaticLabeledEnum {

	/**
	 * Initial status of a flow session; the session has been created but not yet activated.
	 */
	public static final FlowSessionStatus CREATED = new FlowSessionStatus(0, "Created");

	/**
	 * A flow session with STARTING status is about to enter its start state.
	 */
	public static final FlowSessionStatus STARTING = new FlowSessionStatus(1, "Starting");

	/**
	 * A flow session with ACTIVE status is currently executing.
	 */
	public static final FlowSessionStatus ACTIVE = new FlowSessionStatus(2, "Active");

	/**
	 * A flow session with PAUSED status is currently waiting on the user to signal an event.
	 */
	public static final FlowSessionStatus PAUSED = new FlowSessionStatus(3, "Paused");

	/**
	 * A flow session that is SUSPENDED is not actively executing a flow. It is waiting for subflow execution to
	 * complete before continuing.
	 */
	public static final FlowSessionStatus SUSPENDED = new FlowSessionStatus(4, "Suspended");

	/**
	 * A flow session that has ENDED is no longer actively executing a flow. This is the final status of a flow session.
	 */
	public static final FlowSessionStatus ENDED = new FlowSessionStatus(5, "Ended");

	/**
	 * Private constructor because this is a typesafe enum!
	 */
	private FlowSessionStatus(int code, String label) {
		super(code, label);
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy