SecurityCodeAction (Communote 3.5 API)

java.lang.Object
- com.communote.server.model.security.SecurityCodeAction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SecurityCodeActionEnum
```
public class SecurityCodeAction
extends Object
implements Serializable
```
The action of a security code. If more actions than the predefined ones are needed new actions can be defined via define(String)

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static SecurityCodeAction`	`CONFIRM_CLIENT_INVITATION`
`static SecurityCodeAction`	`CONFIRM_EMAIL`
`static SecurityCodeAction`	`CONFIRM_USER`
`static SecurityCodeAction`	`FORGOTTEN_PASSWORD`
`static SecurityCodeAction`	`INVITE_CLIENT`
`static SecurityCodeAction`	`INVITE_USER`
`static SecurityCodeAction`	`REMOVE_CLIENT`
`static SecurityCodeAction`	`REQUEST_MEMBERSHIP`
`static SecurityCodeAction`	`UNLOCK_USER`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SecurityCodeAction()
The default constructor allowing super classes to access it.

Constructors
Modifier	Constructor and Description
`protected`	`SecurityCodeAction()` The default constructor allowing super classes to access it.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object that)`
`static SecurityCodeAction`	`define(String value)` Define a new security code action
`boolean`	`equals(Object object)`
`static SecurityCodeAction`	`fromString(String value)` Creates an instance of SecurityCodeAction from `value`.
`String`	`getValue()` Gets the underlying value of this type safe enumeration.
`int`	`hashCode()`
`static List<String>`	`literals()` Returns an unmodifiable list containing the built-in and additionally defined literals.
`String`	`toString()`
`static void`	`undefine(SecurityCodeAction action)` Remove an action that was previously added via `define(String)`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONFIRM_USER
```
public static final SecurityCodeAction CONFIRM_USER
```
  - CONFIRM_EMAIL
```
public static final SecurityCodeAction CONFIRM_EMAIL
```
  - INVITE_USER
```
public static final SecurityCodeAction INVITE_USER
```
  - REQUEST_MEMBERSHIP
```
public static final SecurityCodeAction REQUEST_MEMBERSHIP
```
  - FORGOTTEN_PASSWORD
```
public static final SecurityCodeAction FORGOTTEN_PASSWORD
```
  - CONFIRM_CLIENT_INVITATION
```
public static final SecurityCodeAction CONFIRM_CLIENT_INVITATION
```
  - INVITE_CLIENT
```
public static final SecurityCodeAction INVITE_CLIENT
```
  - REMOVE_CLIENT
```
public static final SecurityCodeAction REMOVE_CLIENT
```
  - UNLOCK_USER
```
public static final SecurityCodeAction UNLOCK_USER
```
- Constructor Detail
  - SecurityCodeAction
```
protected SecurityCodeAction()
```
    The default constructor allowing super classes to access it.
- Method Detail
  - define
```
public static SecurityCodeAction define(String value)
```
    Define a new security code action
    
    Parameters:
    
    value - the value of the action
    
    Returns:
    
    the added action
  - fromString
```
public static SecurityCodeAction fromString(String value)
```
    Creates an instance of SecurityCodeAction from value.
    
    Parameters:
    
    value - the value to create the SecurityCodeAction from.
    
    Throws:
    
    IllegalArgumentException - in case the value is not among the literals of the built-in or additionally defined actions
  - literals
```
public static List<String> literals()
```
    Returns an unmodifiable list containing the built-in and additionally defined literals.
    
    Returns:
    
    A List containing the actual defined literals, this list can not be modified.
  - undefine
```
public static void undefine(SecurityCodeAction action)
```
    Remove an action that was previously added via define(String). After undefining an action fromString will throw an exception if the action to resolve is not known. The built-in types cannot be undefined.
    
    Parameters:
    
    action - the action to remove
  - compareTo
```
public int compareTo(Object that)
```
    See Also:
    
    Comparable.compareTo(Object)
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(Object)
  - getValue
```
public String getValue()
```
    Gets the underlying value of this type safe enumeration.
    
    Returns:
    
    the underlying value.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class SecurityCodeAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIRM_USER

CONFIRM_EMAIL

INVITE_USER

REQUEST_MEMBERSHIP

FORGOTTEN_PASSWORD

CONFIRM_CLIENT_INVITATION

INVITE_CLIENT

REMOVE_CLIENT

UNLOCK_USER

Constructor Detail

SecurityCodeAction

Method Detail

define

fromString

literals

undefine

compareTo

equals

getValue

hashCode

toString