Package pl.edu.icm.unity.types.registration

Enum ParameterRetrievalSettings

java.lang.Object

java.lang.Enum<ParameterRetrievalSettings>

pl.edu.icm.unity.types.registration.ParameterRetrievalSettings

All Implemented Interfaces:

Serializable, Comparable<ParameterRetrievalSettings>

public enum ParameterRetrievalSettings
extends Enum<ParameterRetrievalSettings>

Defines in what mode the parameter should be collected

Author:

K. Benedyczak

Enum Constant Summary

Enum Constants

Enum Constant	Description
automatic	system must set the value automatically, e.g.
automaticAndInteractive	system sets default value automatically but user can edit it
automaticHidden	as automatic, but the automatically collected value is not shown in the registration form
automaticOrInteractive	if system does not set value user can enter value manually, otherwise remote value is used but not shown
interactive	user must enter the value manually

Method Summary

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

interactive

public static final ParameterRetrievalSettings interactive

user must enter the value manually

automatic

public static final ParameterRetrievalSettings automatic

system must set the value automatically, e.g. by extracting DN from TLS authenticated session or by taking attribute from external idp.

automaticHidden

public static final ParameterRetrievalSettings automaticHidden

as automatic, but the automatically collected value is not shown in the registration form

automaticOrInteractive

public static final ParameterRetrievalSettings automaticOrInteractive

if system does not set value user can enter value manually, otherwise remote value is used but not shown

automaticAndInteractive

public static final ParameterRetrievalSettings automaticAndInteractive

system sets default value automatically but user can edit it

Method Detail

values

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

Returns:

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

valueOf

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

isAutomaticOnly

public boolean isAutomaticOnly()

Returns:

true only if the parameter can be obtained from remote source only

isPotentiallyAutomaticAndVisible

public boolean isPotentiallyAutomaticAndVisible()

Returns:

true only if the parameter can be obtained from remote source and should be shown.

isInteractivelyEntered

public boolean isInteractivelyEntered(boolean hasRemoteValue)