Interface User
- All Superinterfaces:
Countable, Extendable<PropertySet>, Iterable<PropertyValue>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, Serializable
- All Known Subinterfaces:
AuthenticatedUser
- All Known Implementing Classes:
BasicAuthenticatedUser, BasicUser, PyUser
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe preferred language for the user.The master schedule for this user.static final PatternA regex to check for a valid username.Fields inherited from interface PropertySet
EMPTY -
Method Summary
Modifier and TypeMethodDescriptionReturns all the contact information for the usergetId()An opaque identifier that can be used to identify this user.getPath()Generate a path that unambiguously references this userThe name of the user management profile this user was retrieved from.getRoles()Returns a mutable list of roles this user has.Returns all of this user's upcoming schedule adjustmentsvoidsetProfileName(@Nullable String newProfileName) Scripting functions allow adding and editing of users, and profile names may need to change.Methods inherited from interface Iterable
forEach, iterator, spliteratorMethods inherited from interface MutablePropertyValueSource
merge, remove, set, setMethods inherited from interface PropertySet
extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtensionMethods inherited from interface PropertyValueSource
contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues
-
Field Details
-
DEFAULT_SCHEDULE_NAME
- See Also:
-
USERNAME_PATTERN
A regex to check for a valid username.[p{Alnum}][@\\w.\\s\\-]{1,49} -
Username
-
FirstName
-
LastName
-
Password
-
Notes
-
Schedule
-
Language
The preferred language for the user. Will be of the style ofLocale.toString() -
Badge
-
STANDARD_USER_PROPERTIES
-
-
Method Details
-
getProfileName
String getProfileName()The name of the user management profile this user was retrieved from. -
setProfileName
Scripting functions allow adding and editing of users, and profile names may need to change. -
getId
String getId()An opaque identifier that can be used to identify this user. Only valid (unique) within the context of the originating user profile -
getRoles
-
getContactInfo
List<ContactInfo> getContactInfo()Returns all the contact information for the user -
getScheduleAdjustments
List<ScheduleAdjustment> getScheduleAdjustments()Returns all of this user's upcoming schedule adjustments -
getPath
QualifiedPath getPath()Generate a path that unambiguously references this user
-