EmailValidation (Cyclos 4.13 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<EmailValidation>
- - org.cyclos.model.users.users.EmailValidation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EmailValidation>, HasMessageKey
```
public enum EmailValidation
extends java.lang.Enum<EmailValidation>
implements HasMessageKey
```
Possible values for email validation

Author:

jcomas

Enum Constant Summary

Enum Constants
Enum Constant and Description
`EDIT_BY_ADMIN` Email validation will be sent when an administrator changes a managed user's email
`EDIT_BY_BROKER` Email validation will be sent when a broker changes a managed user's email
`EDIT_BY_SELF` Email validation will be sent when the user changes his email.
`IMPORTED_USERS` Email validation will be sent when the user is imported.
`OPERATOR_REGISTRATION_BY_MEMBER` Email validation will be sent upon operator registrations made by their owner members.
`PUBLIC_REGISTRATION` Email validation will be sent upon public registration
`REGISTRATION_BY_ADMIN` Email validation will be sent upon registrations made by administrators.
`REGISTRATION_BY_BROKER` Email validation will be sent upon registrations made by brokers.
`REGISTRATION_BY_MEMBER` Email validation will be sent upon registrations made by members.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageKey`	`getMessageKey()`
`static EmailValidation`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EmailValidation[]`	`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
  - PUBLIC_REGISTRATION
```
public static final EmailValidation PUBLIC_REGISTRATION
```
    Email validation will be sent upon public registration
  - REGISTRATION_BY_ADMIN
```
public static final EmailValidation REGISTRATION_BY_ADMIN
```
    Email validation will be sent upon registrations made by administrators.
  - REGISTRATION_BY_BROKER
```
public static final EmailValidation REGISTRATION_BY_BROKER
```
    Email validation will be sent upon registrations made by brokers.
  - REGISTRATION_BY_MEMBER
```
public static final EmailValidation REGISTRATION_BY_MEMBER
```
    Email validation will be sent upon registrations made by members.
  - OPERATOR_REGISTRATION_BY_MEMBER
```
public static final EmailValidation OPERATOR_REGISTRATION_BY_MEMBER
```
    Email validation will be sent upon operator registrations made by their owner members.
  - EDIT_BY_SELF
```
public static final EmailValidation EDIT_BY_SELF
```
    Email validation will be sent when the user changes his email.
  - EDIT_BY_ADMIN
```
public static final EmailValidation EDIT_BY_ADMIN
```
    Email validation will be sent when an administrator changes a managed user's email
  - EDIT_BY_BROKER
```
public static final EmailValidation EDIT_BY_BROKER
```
    Email validation will be sent when a broker changes a managed user's email
  - IMPORTED_USERS
```
public static final EmailValidation IMPORTED_USERS
```
    Email validation will be sent when the user is imported.
- Method Detail
  - values
```
public static EmailValidation[] 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 (EmailValidation c : EmailValidation.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EmailValidation valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey

Enum EmailValidation

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PUBLIC_REGISTRATION

REGISTRATION_BY_ADMIN

REGISTRATION_BY_BROKER

REGISTRATION_BY_MEMBER

OPERATOR_REGISTRATION_BY_MEMBER

EDIT_BY_SELF

EDIT_BY_ADMIN

EDIT_BY_BROKER

IMPORTED_USERS

Method Detail

values

valueOf

getMessageKey