com.inductiveautomation.ignition.common.user

Enum UserSourceEditCapability

java.lang.Object

java.lang.Enum<UserSourceEditCapability>

com.inductiveautomation.ignition.common.user.UserSourceEditCapability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserSourceEditCapability>

public enum UserSourceEditCapability
extends java.lang.Enum<UserSourceEditCapability>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_ROLE
ADD_USER
DELETE_ROLE
DELETE_USER
EDIT_PASSWORD Can the user's password be changed?
EDIT_USER_META Can the user's meta data (incl.
EDIT_USERNAME Can the user's username be changed?
RENAME_ROLE

Method Summary

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

EDIT_USERNAME

public static final UserSourceEditCapability EDIT_USERNAME

Can the user's username be changed?

EDIT_PASSWORD

public static final UserSourceEditCapability EDIT_PASSWORD

Can the user's password be changed?

EDIT_USER_META

public static final UserSourceEditCapability EDIT_USER_META

Can the user's meta data (incl. roles, contactinfo, schedules) be edited?

ADD_USER

public static final UserSourceEditCapability ADD_USER

DELETE_USER

public static final UserSourceEditCapability DELETE_USER

ADD_ROLE

public static final UserSourceEditCapability ADD_ROLE

RENAME_ROLE

public static final UserSourceEditCapability RENAME_ROLE

DELETE_ROLE

public static final UserSourceEditCapability DELETE_ROLE

Method Detail

values

public static UserSourceEditCapability[] 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 (UserSourceEditCapability c : UserSourceEditCapability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UserSourceEditCapability 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