UrgentSituation (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<UrgentSituation>
- - org.cyclos.impl.access.UrgentSituation

All Implemented Interfaces:

Serializable, Comparable<UrgentSituation>
```
public enum UrgentSituation
extends Enum<UrgentSituation>
```
A situation that needs to be handled by users as soon as they login. These situations prevent the user from accessing the system in a stateless way.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`EXPIRED_PASSWORD`	The channel access password has expired
`LOGIN_CONFIRMATION`	The user must confirm the login
`PENDING_AGREEMENT`	There's at least one agreement that hasn't been accepted by the user

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static UrgentSituation`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static UrgentSituation[]`	`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
  - PENDING_AGREEMENT
```
public static final UrgentSituation PENDING_AGREEMENT
```
    There's at least one agreement that hasn't been accepted by the user
  - EXPIRED_PASSWORD
```
public static final UrgentSituation EXPIRED_PASSWORD
```
    The channel access password has expired
  - LOGIN_CONFIRMATION
```
public static final UrgentSituation LOGIN_CONFIRMATION
```
    The user must confirm the login
- Method Detail
  - values
```
public static UrgentSituation[] 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 (UrgentSituation c : UrgentSituation.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UrgentSituation 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