Package com.inductiveautomation.ignition.common.user

Enum Class UserSourceEditCapability

java.lang.Object

java.lang.Enum<UserSourceEditCapability>

com.inductiveautomation.ignition.common.user.UserSourceEditCapability

All Implemented Interfaces:

Serializable, Comparable<UserSourceEditCapability>, Constable

public enum UserSourceEditCapability
extends Enum<UserSourceEditCapability>

This enumeration contains capabilities that a user source can support. The full set of supported capabilities should be returned via the user source's implementation of getEditFlags().

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD_ROLE	Can a role be added?
ADD_USER	Can a user be added?
DELETE_ROLE	Can a role be deleted?
DELETE_USER	Can a user be deleted?
EDIT_PASSWORD	Can the user's password be changed?
EDIT_ROLE_META	Can the role's metadata be edited?
EDIT_ROLENAME	Can the role's name be changed?
EDIT_USER_META	Can the user's meta data (incl.
EDIT_USERNAME	Can the user's username be changed?

Method Summary

Modifier and Type	Method	Description
static UserSourceEditCapability	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserSourceEditCapability[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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

Can a user be added?

DELETE_USER

public static final UserSourceEditCapability DELETE_USER

Can a user be deleted?

ADD_ROLE

public static final UserSourceEditCapability ADD_ROLE

Can a role be added?

EDIT_ROLENAME

public static final UserSourceEditCapability EDIT_ROLENAME

Can the role's name be changed?

EDIT_ROLE_META

public static final UserSourceEditCapability EDIT_ROLE_META

Can the role's metadata be edited?

DELETE_ROLE

public static final UserSourceEditCapability DELETE_ROLE

Can a role be deleted?

Method Details

values

public static UserSourceEditCapability[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UserSourceEditCapability valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null