com.yosokumo.core
Enum Study.Visibility

java.lang.Object
  java.lang.Enum<Study.Visibility>
      com.yosokumo.core.Study.Visibility

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Study.Visibility>

Enclosing class:

Study

public static enum Study.Visibility
extends java.lang.Enum<Study.Visibility>

Tells whether unidentified users can get estimated predictands from the model of the study. The visibility of a study can be changed at any time. If the visibility is not included in the posted study document, the default visibility is PRIVATE.

Enum Constant Summary

PRIVATE
only users that are authenticated and authorized may make a Get Model request for the study.

PUBLIC
any web client may make a Get Model request for the study.

Method Summary

static Study.Visibility	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Study.Visibility[]	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

PRIVATE

public static final Study.Visibility PRIVATE

only users that are authenticated and authorized may make a Get Model request for the study.

PUBLIC

public static final Study.Visibility PUBLIC

any web client may make a Get Model request for the study.

Method Detail

values

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

Returns:

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

valueOf

public static Study.Visibility valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null