UsersSubmodule (Cyclos 4.3.2 Scripting API Documentation)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UsersSubmodule>, Submodule
```
public enum UsersSubmodule
extends java.lang.Enum<UsersSubmodule>
implements Submodule
```
Submodules for the USERS module

Author:

luis

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADDRESSES`
`BROKERING`
`BULK_ACTIONS`
`DASHBOARD`
`DASHBOARD_SETTINGS`
`FIELDS`
`GROUPS`
`IMAGES`
`PHONES`
`PRODUCTS`
`RECORD_FIELDS`
`RECORD_TYPES`
`RECORDS`
`REFERENCES`
`USERS`

Method Summary

Methods
Modifier and Type	Method and Description
`Module`	`module()` Returns the module for this submodule
`static UsersSubmodule`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static UsersSubmodule[]`	`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

Methods inherited from interface org.cyclos.model.Submodule
name

- Enum Constant Detail
  - ADDRESSES
```
public static final UsersSubmodule ADDRESSES
```
  - BROKERING
```
public static final UsersSubmodule BROKERING
```
  - BULK_ACTIONS
```
public static final UsersSubmodule BULK_ACTIONS
```
  - DASHBOARD
```
public static final UsersSubmodule DASHBOARD
```
  - DASHBOARD_SETTINGS
```
public static final UsersSubmodule DASHBOARD_SETTINGS
```
  - GROUPS
```
public static final UsersSubmodule GROUPS
```
  - PHONES
```
public static final UsersSubmodule PHONES
```
  - PRODUCTS
```
public static final UsersSubmodule PRODUCTS
```
  - REFERENCES
```
public static final UsersSubmodule REFERENCES
```
  - FIELDS
```
public static final UsersSubmodule FIELDS
```
  - RECORD_FIELDS
```
public static final UsersSubmodule RECORD_FIELDS
```
  - RECORDS
```
public static final UsersSubmodule RECORDS
```
  - RECORD_TYPES
```
public static final UsersSubmodule RECORD_TYPES
```
  - IMAGES
```
public static final UsersSubmodule IMAGES
```
  - USERS
```
public static final UsersSubmodule USERS
```
- Method Detail
  - values
```
public static UsersSubmodule[] 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 (UsersSubmodule c : UsersSubmodule.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UsersSubmodule 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
  - module
```
public Module module()
```
    Description copied from interface: Submodule
    
    Returns the module for this submodule
    
    Specified by:
    
    module in interface Submodule

Enum UsersSubmodule

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.model.Submodule

Enum Constant Detail

ADDRESSES

BROKERING

BULK_ACTIONS

DASHBOARD

DASHBOARD_SETTINGS

GROUPS

PHONES

PRODUCTS

REFERENCES

FIELDS

RECORD_FIELDS

RECORDS

RECORD_TYPES

IMAGES

USERS

Method Detail

values

valueOf

module