Package io.goobi.viewer.api.rest.model.tasks

Enum Class Task.Accessibility

java.lang.Object

java.lang.Enum<Task.Accessibility>

io.goobi.viewer.api.rest.model.tasks.Task.Accessibility

All Implemented Interfaces:

Serializable, Comparable<Task.Accessibility>, Constable

Enclosing class:

Task

public static enum Task.Accessibility
extends Enum<Task.Accessibility>

Enumerates the access levels that control which callers are permitted to read or monitor a Task.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMIN	Only users with admin rights may access this task.
PUBLIC	Anyone may access this task.
SESSION	Anyone may access this tasks, but they are only visible within the session in which they were created.
TOKEN	This task is only accessibly by requests containing a valid access token.

Method Summary

Modifier and Type	Method	Description
static Task.Accessibility	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Task.Accessibility[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PUBLIC

public static final Task.Accessibility PUBLIC

Anyone may access this task.

SESSION

public static final Task.Accessibility SESSION

Anyone may access this tasks, but they are only visible within the session in which they were created.

ADMIN

public static final Task.Accessibility ADMIN

Only users with admin rights may access this task.

TOKEN

public static final Task.Accessibility TOKEN

This task is only accessibly by requests containing a valid access token.

Method Details

values

public static Task.Accessibility[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Task.Accessibility valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null