Package com.inductiveautomation.ignition.common.user

Class BasicUser

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

com.inductiveautomation.ignition.common.user.BasicUser

All Implemented Interfaces:

Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, User, Serializable, Iterable<PropertyValue>

Direct Known Subclasses:

BasicAuthenticatedUser

public class BasicUser
extends BasicPropertySet
implements User

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

BasicPropertySet.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ContactInfo>	contactInfo
protected Serializable	id
protected String	profileName
protected Collection<String>	roles
protected List<ScheduleAdjustment>	scheduleAdjustments

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Fields inherited from interface com.inductiveautomation.ignition.common.user.User

Badge, DEFAULT_SCHEDULE_NAME, FirstName, Language, LastName, Notes, Password, Schedule, Username, USERNAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
BasicUser(String profileName, Serializable id, Collection<String> roles)
BasicUser(String profileName, Serializable id, Collection<String> roles, List<ContactInfo> contactInfo)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<ContactInfo>	getContactInfo()	Returns all of the contact information for the user
Serializable	getId()	An opaque identifier that can be used to identify this user.
QualifiedPath	getPath()	Generate an path that unambiguously references this user
String	getProfileName()	The name of the user management profile this user was retrieved from.
Collection<String>	getRoles()	Returns all of the roles this user is a has.
List<ScheduleAdjustment>	getScheduleAdjustments()	Returns all of this user's upcoming schedule adjustments
int	hashCode()
BasicUser	setContactInfo(List<ContactInfo> contactInfo)
void	setProfileName(String newProfileName)	Scripting functions allow adding and editing of users, and profile names may need to change.
BasicUser	setRoles(Collection<String> roles)
BasicUser	setScheduleAdjustments(List<ScheduleAdjustment> scheduleAdjustments)

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

addPropertyChangeListener, addPropertyChangeListener, change, coerceValue, contains, firePropertyChange, get, getCount, getExtension, getOrDefault, getOrElse, getProperties, getRaw, getRawValueMap, getValues, isExtended, isInherited, iterator, of, remove, removePropertyChangeListener, removePropertyChangeListener, set, set, setDirect, setImpl, setRawValueMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable

getCount

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource

merge, remove, set, set

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource

contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues

Field Details

profileName

protected String profileName

id

protected Serializable id

roles

protected Collection<String> roles

contactInfo

protected List<ContactInfo> contactInfo

scheduleAdjustments

protected List<ScheduleAdjustment> scheduleAdjustments

Constructor Details

BasicUser

public BasicUser(String profileName,
 Serializable id,
 Collection<String> roles)

BasicUser

public BasicUser(String profileName,
 Serializable id,
 Collection<String> roles,
 List<ContactInfo> contactInfo)

Method Details

setRoles

public BasicUser setRoles(@Nullable
 Collection<String> roles)

setContactInfo

public BasicUser setContactInfo(@Nullable
 List<ContactInfo> contactInfo)

setScheduleAdjustments

public BasicUser setScheduleAdjustments(@Nullable
 List<ScheduleAdjustment> scheduleAdjustments)

setProfileName

public void setProfileName(@Nullable
 String newProfileName)

Description copied from interface: User

Scripting functions allow adding and editing of users, and profile names may need to change.

Specified by:

setProfileName in interface User

equals

public boolean equals(Object obj)

Overrides:

equals in class BasicPropertySet

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getProfileName

public String getProfileName()

Description copied from interface: User

The name of the user management profile this user was retrieved from.

Specified by:

getProfileName in interface User

getId

public Serializable getId()

Description copied from interface: User

An opaque identifier that can be used to identify this user. Only valid (unique) within the context of the originating user profile

Specified by:

getId in interface User

getRoles

@Nonnull
public Collection<String> getRoles()

Description copied from interface: User

Returns all of the roles this user is a has. Not null.

Specified by:

getRoles in interface User

getContactInfo

@Nonnull
public List<ContactInfo> getContactInfo()

Description copied from interface: User

Returns all of the contact information for the user

Specified by:

getContactInfo in interface User

getScheduleAdjustments

@Nonnull
public List<ScheduleAdjustment> getScheduleAdjustments()

Description copied from interface: User

Returns all of this user's upcoming schedule adjustments

Specified by:

getScheduleAdjustments in interface User

getPath

public QualifiedPath getPath()

Description copied from interface: User

Generate an path that unambiguously references this user

Specified by:

getPath in interface User