edu.utah.further.fqe.ds.api.domain
Enum QueryState

java.lang.Object
  java.lang.Enum<QueryState>
      edu.utah.further.fqe.ds.api.domain.QueryState

All Implemented Interfaces:

State<QueryState,QueryAction,QueryContext>, Serializable, Comparable<QueryState>

public enum QueryState
extends Enum<QueryState>
implements State<QueryState,QueryAction,QueryContext>

Query context state. Each state implements its handling functions within the corresponding enumerated constant inner class.

-----------------------------------------------------------------------------------
(c) 2008-2011 FURTHeR Project, Health Sciences IT, University of Utah
Contact: Dr. Scott Narus <scott.narus@hsc.utah.edu>
Biomedical Informatics, 26 South 2000 East
Room 5775 HSEB, Salt Lake City, UT 84112
Day Phone: 1-801-213-3288
-----------------------------------------------------------------------------------

Version:

May 28, 2009

Author:

Oren E. Livne <oren.livne@utah.edu>

Enum Constant Summary

COMPLETED
Query execution is complete.

EXECUTING
The query is currently running.

FAILED
Query execution failed.

INVALID
A invalid state where the query cannot be considered for any of the other states.

QUEUED
The query's context has been persisted to the database.

STOPPED
Query execution is stopped.

SUBMITTED
The query's context is created and transient.

Method Summary

static QueryState	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

SUBMITTED

public static final QueryState SUBMITTED

The query's context is created and transient.

QUEUED

public static final QueryState QUEUED

The query's context has been persisted to the database. The query is queued for processing by the FQE.

EXECUTING

public static final QueryState EXECUTING

The query is currently running.

STOPPED

public static final QueryState STOPPED

Query execution is stopped. This is a recoverable state.

COMPLETED

public static final QueryState COMPLETED

Query execution is complete. This is an unrecoverable state.

FAILED

public static final QueryState FAILED

Query execution failed. This is an unrecoverable state.

INVALID

public static final QueryState INVALID

A invalid state where the query cannot be considered for any of the other states.

Method Detail

values

public static QueryState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QueryState c : QueryState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueryState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null