java.lang.Object
- java.lang.Enum<LocateUserOption>
- - org.cyclos.impl.users.LocateUserOption

All Implemented Interfaces:

Serializable, Comparable<LocateUserOption>
```
public enum LocateUserOption
extends Enum<LocateUserOption>
```
Contains options for the locate user operation

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ACCOUNT_OWNER_ONLY`	Only returns users with status contained in `AccountServiceLocal.POSSIBLE_STATUSES_TO_OWN_ACCOUNTS`
`ACTIVE_ONLY`	Only return active users (blocked and disabled are ignored too)
`ENFORCE_CHANNEL`	It will be enforced that the located user has the principal type used for locating enabled.
`FOR_ACCESS`	Locating user for access (login or stateless).
`IGNORE_HIDDEN`	May find other users by fields which are marked as hidden (private), like custom fields or e-mail
`INVERSE_RELATION`	Instead of ensuring the logged user relates to the located user, ensures the located user relates to the logged user
`RECORD_FAILURE`	Records the failed locate attempts, blocking the user if exceeding the maximum tries
`STATUS_EXCEPTION`	When the user doesn't have the expected status, throw an `UserStatusException` with the specific status

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static LocateUserOption`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static LocateUserOption[]`	`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
  - FOR_ACCESS
```
public static final LocateUserOption FOR_ACCESS
```
    Locating user for access (login or stateless). When using this, users are returned regardless of the status, because additional conditions are checked later. If the password is correct, more info is sent, so we can't throw an exception on locate.
  - IGNORE_HIDDEN
```
public static final LocateUserOption IGNORE_HIDDEN
```
    May find other users by fields which are marked as hidden (private), like custom fields or e-mail
  - ACTIVE_ONLY
```
public static final LocateUserOption ACTIVE_ONLY
```
    Only return active users (blocked and disabled are ignored too)
  - ACCOUNT_OWNER_ONLY
```
public static final LocateUserOption ACCOUNT_OWNER_ONLY
```
    Only returns users with status contained in AccountServiceLocal.POSSIBLE_STATUSES_TO_OWN_ACCOUNTS
  - STATUS_EXCEPTION
```
public static final LocateUserOption STATUS_EXCEPTION
```
    When the user doesn't have the expected status, throw an UserStatusException with the specific status
  - RECORD_FAILURE
```
public static final LocateUserOption RECORD_FAILURE
```
    Records the failed locate attempts, blocking the user if exceeding the maximum tries
  - INVERSE_RELATION
```
public static final LocateUserOption INVERSE_RELATION
```
    Instead of ensuring the logged user relates to the located user, ensures the located user relates to the logged user
  - ENFORCE_CHANNEL
```
public static final LocateUserOption ENFORCE_CHANNEL
```
    It will be enforced that the located user has the principal type used for locating enabled. When this flag is set, the products used to check will be filtered by the current channel.
- Method Detail
  - values
```
public static LocateUserOption[] 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 (LocateUserOption c : LocateUserOption.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LocateUserOption 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

Enum LocateUserOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FOR_ACCESS

IGNORE_HIDDEN

ACTIVE_ONLY

ACCOUNT_OWNER_ONLY

STATUS_EXCEPTION

RECORD_FAILURE

INVERSE_RELATION

ENFORCE_CHANNEL

Method Detail

values

valueOf