Enum Class ParameterRetrievalSettings
java.lang.Object
java.lang.Enum<ParameterRetrievalSettings>
pl.edu.icm.unity.types.registration.ParameterRetrievalSettings
- All Implemented Interfaces:
Serializable
,Comparable<ParameterRetrievalSettings>
,Constable
Defines in what mode the parameter should be collected
- Author:
- K. Benedyczak
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionsystem must set the value automatically, e.g.system sets default value automatically but user can edit itas automatic, but the automatically collected value is not shown in the registration formif system does not set value user can enter value manually, otherwise remote value is used but not shownuser must enter the value manually -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
isInteractivelyEntered
(boolean hasRemoteValue) boolean
static ParameterRetrievalSettings
Returns the enum constant of this class with the specified name.static ParameterRetrievalSettings[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
interactive
user must enter the value manually -
automatic
system must set the value automatically, e.g. by extracting DN from TLS authenticated session or by taking attribute from external idp. -
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 -
automaticAndInteractive
system sets default value automatically but user can edit it
-
-
Method Details
-
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
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 nameNullPointerException
- 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)
-