com.inductiveautomation.ignition.common.user

Class PyUser

java.lang.Object

com.inductiveautomation.ignition.common.user.PyUser

All Implemented Interfaces:

Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, User, java.io.Serializable, java.lang.Iterable<PropertyValue>

public class PyUser
extends java.lang.Object
implements User

A User implementation that delegates to another user object, but has some methods that are more scripting friendly.

See Also:

Serialized Form

Field Summary

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

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

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
PyUser(User user)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Property<?> prop)
<T> T	get(Property<T> prop) Retrieves the value of the property, or null if this set doesn't contain that property.
java.lang.Object	get(java.lang.String propertyName)
java.util.List<ContactInfo>	getContactInfo() Returns all of the contact information for the user
int	getCount()
java.io.Serializable	getId() An opaque identifier that can be used to identify this user.
<T> T	getOrDefault(Property<T> prop)
<T> T	getOrElse(Property<T> property, T value) Get the value for a given Property, or else fall back to value if it's not present.
QualifiedPath	getPath() Generate an path that unambiguously references this user
java.lang.String	getProfileName() The name of the user management profile this user was retrieved from.
java.util.Collection<Property<?>>	getProperties()
java.util.Collection<java.lang.String>	getRoles() Returns all of the roles this user is a has.
java.util.List<ScheduleAdjustment>	getScheduleAdjustments() Returns all of this user's upcoming schedule adjustments
java.util.List<PropertyValue>	getValues()
boolean	isExtended(Property<?> prop) Returns whether this property set contains a value for the prop, and the prop was actually inherited.
boolean	isInherited(Property<?> prop) Indicates whether the property was inherited from a parent type.
java.util.Iterator<PropertyValue>	iterator()
void	merge(PropertySet other, boolean localOnly) Merges the values from other collection into this one.
void	remove(Property<?> prop)
<T> void	set(Property<T> prop, T value)
void	set(PropertyValue propValue)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

builder, extend, getExtension, newDefaultInstance, newExtension

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

merge

Constructor Detail

PyUser

public PyUser(User user)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

public java.lang.Object get(java.lang.String propertyName)

contains

public boolean contains(Property<?> prop)

Specified by:

contains in interface PropertyValueSource

Returns:

True if the source contains a value for prop.

getOrDefault

public <T> T getOrDefault(Property<T> prop)

Specified by:

getOrDefault in interface PropertyValueSource

Returns:

The value for prop or Property.getDefaultValue() if not present.

get

public <T> T get(Property<T> prop)

Description copied from interface: PropertyValueSource

Retrieves the value of the property, or null if this set doesn't contain that property.

Specified by:

get in interface PropertyValueSource

iterator

public java.util.Iterator<PropertyValue> iterator()

Specified by:

iterator in interface java.lang.Iterable<PropertyValue>

set

public <T> void set(Property<T> prop,
                    T value)

Specified by:

set in interface MutablePropertyValueSource

getOrElse

public <T> T getOrElse(Property<T> property,
                       T value)

Description copied from interface: PropertyValueSource

Get the value for a given Property, or else fall back to value if it's not present.

Specified by:

getOrElse in interface PropertyValueSource

Parameters:

property - The Property for which a value is to be retrieved.

value - The value to default to if property isn't present.

Returns:

The value of property if present, value if not.

set

public void set(PropertyValue propValue)

Specified by:

set in interface MutablePropertyValueSource

remove

public void remove(Property<?> prop)

Specified by:

remove in interface MutablePropertyValueSource

getCount

public int getCount()

Specified by:

getCount in interface Countable

getProperties

public java.util.Collection<Property<?>> getProperties()

Specified by:

getProperties in interface PropertyValueSource

getValues

public java.util.List<PropertyValue> getValues()

Specified by:

getValues in interface PropertyValueSource

isExtended

public boolean isExtended(Property<?> prop)

Description copied from interface: PropertySet

Returns whether this property set contains a value for the prop, and the prop was actually inherited. In other words, this is true if the property is inherited, and an override value is present.

Specified by:

isExtended in interface PropertySet

isInherited

public boolean isInherited(Property<?> prop)

Description copied from interface: PropertySet

Indicates whether the property was inherited from a parent type.

Specified by:

isInherited in interface PropertySet

merge

public void merge(PropertySet other,
                  boolean localOnly)

Description copied from interface: Mergable

Merges the values from other collection into this one. Replaces any currently existing value with those from the other set.

Specified by:

merge in interface Mergable<PropertySet>

Specified by:

merge in interface MutablePropertyValueSource

getProfileName

public java.lang.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 java.io.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

public java.util.Collection<java.lang.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

public java.util.List<ContactInfo> getContactInfo()

Description copied from interface: User

Returns all of the contact information for the user

Specified by:

getContactInfo in interface User

getScheduleAdjustments

public java.util.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