org.sagebionetworks.bridge.rest.model

Enum SessionCompletionState

java.lang.Object

java.lang.Enum<SessionCompletionState>

org.sagebionetworks.bridge.rest.model.SessionCompletionState

All Implemented Interfaces:

Serializable, Comparable<SessionCompletionState>

public enum SessionCompletionState
extends Enum<SessionCompletionState>

How search criteria should be evaluated in a search. |Status|Description| |---|---| | not_yet_available | Session will occur but is still in the future for the participant. | | unstarted | Session is currently available to be started by the participant. | | started | Session is available and started. | | completed | Session was completed before it expired. | | abandoned | Session was started, but it expired before it was finished; it is not in compliance. | | expired | Session is now in the past for the participant and never started; it is not in compliance. | | not_applicable | Session will not occur for this participant because they don't have the triggering event. | | declined | After becoming available but before expiring, the session was declined; it is not in compliance. |

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionCompletionState.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABANDONED
COMPLETED
DECLINED
EXPIRED
NOT_APPLICABLE
NOT_YET_AVAILABLE
STARTED
UNSTARTED

Method Summary

Modifier and Type	Method and Description
static SessionCompletionState	fromValue(String text)
String	getValue()
String	toString()
static SessionCompletionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static SessionCompletionState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_YET_AVAILABLE

public static final SessionCompletionState NOT_YET_AVAILABLE

UNSTARTED

public static final SessionCompletionState UNSTARTED

STARTED

public static final SessionCompletionState STARTED

COMPLETED

public static final SessionCompletionState COMPLETED

ABANDONED

public static final SessionCompletionState ABANDONED

EXPIRED

public static final SessionCompletionState EXPIRED

NOT_APPLICABLE

public static final SessionCompletionState NOT_APPLICABLE

DECLINED

public static final SessionCompletionState DECLINED

Method Detail

values

public static SessionCompletionState[] 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 (SessionCompletionState c : SessionCompletionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static SessionCompletionState 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<SessionCompletionState>

fromValue

public static SessionCompletionState fromValue(String text)