org.jasig.portlet.survey

Enum PublishedState

java.lang.Object

java.lang.Enum<PublishedState>

org.jasig.portlet.survey.PublishedState

All Implemented Interfaces:

Serializable, Comparable<PublishedState>

public enum PublishedState
extends Enum<PublishedState>

Represents a state that a survey or part of a survey is currently in, such as published or unpublished This list is intended to be comprehensive, but new states may be added in the future as needed. Survey data sources are afforded reasonable latitude as to when and how a survey enters into a state. View implementations vary as to how they represent a state to a user, or whether they represent it.

Since:

1.0

Author:

chasegawa

Enum Constant Summary

Enum Constants

Enum Constant and Description
PUBLISHED Once a survey moves to a published state, no further changes should be allowed to the content of the survey.
UNPUBLISHED Default state of any new survey.

Method Summary

Modifier and Type	Method and Description
static PublishedState	valueOf(String name) Returns the enum constant of this type with the specified name.
static PublishedState[]	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

Enum Constant Detail

UNPUBLISHED

public static final PublishedState UNPUBLISHED

Default state of any new survey.

PUBLISHED

public static final PublishedState PUBLISHED

Once a survey moves to a published state, no further changes should be allowed to the content of the survey. A user's responses would always be linked to the id of a published survey.

Method Detail

values

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

Returns:

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

valueOf

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