java.lang.Object
- com.uc4.api.objects.UserAttributes

```
public class UserAttributes
extends java.lang.Object
```
This class stores user attributes like first name, last name and email address.

Constructor Summary

Constructors
Modifier Constructor Description

protected UserAttributes(com.uc4.util.XMLDocument doc)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`disableLogonTimeSpan()`	Disables the logon time span limitation.
`CalendarCondition`	`getCalendar()`	Returns the authorization check according to the Calendar.
`UC4ObjectName`	`getDefaultLogin()`	Returns the Login object for the database access of Variable objects with the source "SQL".
`java.lang.String`	`getDistinguishedName()`	Returns the distinguished name of this user.
`java.lang.String`	`getEmail1()`	Returns the first Email address of this user.
`java.lang.String`	`getEmail2()`	Returns the second Email address of this user.
`java.lang.String`	`getFirstName()`
`java.lang.String`	`getLastName()`
`int`	`getMaxParallelSessions()`	Returns the maximum number of parallel login sessions a user may have.
`int`	`getMinActivityRefresh()`	Returns the User-specific minimum interval in seconds for refreshing activities (display refresh).
`UC4TimezoneName`	`getTimezone()`	Returns the TimeZone to be used for this user following System logon.
`Time`	`getValidTimeFrom()`	If `hasLogonTimeSpan()` is `true` this method returns the lower limit of the allowed logon time.
`Time`	`getValidTimeTo()`	If `hasLogonTimeSpan()` is `true` this method returns the upper limit of the allowed logon time.
`boolean`	`hasLogonTimeSpan()`	Returns `true` if a logon time span has been set for this User.
`boolean`	`isActive()`	Returns `true` if the user is active.
`boolean`	`isIgnoreSSO()`	Returns `true` if SSO is to be ignored.
`boolean`	`isLDAPConnection()`	Returns `true` if LDAP is enabled for this user.
`boolean`	`isLDAPConnectionSystem()`	Returns `true` if LDAP is enabled for the system.
`boolean`	`isLocked()`	Returns `true` if the user is locked.
`boolean`	`isPasswordChangeRequired()`	Returns `true` if a password change is required for this user.
`boolean`	`isPasswordNeverExpires()`	Returns `true` if the password never expires.
`void`	`setActive(boolean active)`	Changes the status of this User.
`void`	`setCalendar(CalendarCondition cond)`	Sets the authorization check according to the Calendar.
`void`	`setDefaultLogin(UC4ObjectName defaultLogin)`	Sets the Login object for the database access of Variable objects with the source "SQL".
`void`	`setDistinguishedName(java.lang.String distinguishedName)`	Set the distinguished name for the LDAP connection.
`void`	`setEmail1(java.lang.String email1)`	Sets the first Email address of this user.
`void`	`setEmail2(java.lang.String email2)`	Sets the second Email address of this user.
`void`	`setFirstName(java.lang.String firstName)`	Sets the first name of this user.
`void`	`setIgnoreSSO(boolean ignoreSSO)`	Changes the ignore SSO setting.
`void`	`setLastName(java.lang.String lastName)`	Sets the last name of the user.
`void`	`setLDAPConnection(boolean ldapConnection)`	Enables or disables the LDAP Connection.
`void`	`setLocked(boolean locked)`	This method can be used to lock or unlock a User.
`void`	`setLogonTimeSpan(Time from, Time to)`	Sets the time span in which a logon is allowed.
`void`	`setMaxParallelSessions(int multiLogon)`	Sets the maximum number of parallel login sessions a user may have.
`void`	`setMinActivityRefresh(int refresh)`	Sets the User-specific minimum interval in seconds for refreshing activities (display refresh).
`void`	`setPassword(java.lang.String pass)`	Sets the password of this user.
`void`	`setPasswordChangeRequired(boolean passwordMustChange)`	Changes the setting for a password change.
`void`	`setPasswordNeverExpires(boolean passwordNeverExpires)`	Changes the password expiration setting.
`void`	`setTimezone(UC4TimezoneName timezone)`	Sets the TimeZone to be used for this user following System logon.
`protected void`	`store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserAttributes
```
protected UserAttributes(com.uc4.util.XMLDocument doc)
```
- Method Detail
  - store
```
protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element objectElement,
                     ConnectionAttributes sessionInfo)
```
  - setPassword
```
public void setPassword(java.lang.String pass)
```
    Sets the password of this user. If users are in various international locations, special national language characters -- umlauts, accents, special letters, etc. -- should be avoided. Not all keyboards in all countries support such characters.
    
    Parameters:
    
    pass - Password
  - isActive
```
public boolean isActive()
```
    Returns true if the user is active. Active means that the user may log on to the Automation Engine. Inactive users must not log on to the system; logically, they are no longer part of the system.
    
    Returns:
    
    Returns true if the user is active
  - setActive
```
public void setActive(boolean active)
```
    Changes the status of this User.
    
    Parameters:
    
    active - true if the user should be active, false if the user should not be allowed to log on to the system.
  - isLocked
```
public boolean isLocked()
```
    Returns true if the user is locked. The repeated indication of a wrong password has the effect that a user is locked.
    
    Returns:
    
    Returns true if the user is locked
  - setLocked
```
public void setLocked(boolean locked)
```
    This method can be used to lock or unlock a User.
    
    Parameters:
    
    locked - true if the user should be locked, false to unlock the user
  - getFirstName
```
public java.lang.String getFirstName()
```
    Returns:
    
    First name of the user
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    Sets the first name of this user. The first and last names of the user are displayed in various areas of the UserInterface. For example, in the System Overview.
    
    Parameters:
    
    firstName - User's first name, max. 20 characters
  - getLastName
```
public java.lang.String getLastName()
```
    Returns:
    
    Last name of the user
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    Sets the last name of the user. The first and last names of the user are displayed in various areas of the UserInterface. For example, in the System Overview.
    
    Parameters:
    
    lastName - User's last name, max. 20 characters
  - getEmail1
```
public java.lang.String getEmail1()
```
    Returns the first Email address of this user.
    
    Returns:
    
    User's Email address
  - setEmail1
```
public void setEmail1(java.lang.String email1)
```
    Sets the first Email address of this user.
    
    Parameters:
    
    email1 - User's Email address, max. 50 characters
  - getEmail2
```
public java.lang.String getEmail2()
```
    Returns the second Email address of this user.
    
    Returns:
    
    User's Email address
  - setEmail2
```
public void setEmail2(java.lang.String email2)
```
    Sets the second Email address of this user.
    
    Parameters:
    
    email2 - User's Email address, max. 50 characters
  - getDefaultLogin
```
public UC4ObjectName getDefaultLogin()
```
    Returns the Login object for the database access of Variable objects with the source "SQL". The specified Login will only be used if the User has logged on and if the setting "Apply User's Login" has been specified.
    
    Returns:
    
    Name of the LOGIN Object
  - setDefaultLogin
```
public void setDefaultLogin(UC4ObjectName defaultLogin)
```
    Sets the Login object for the database access of Variable objects with the source "SQL". The specified Login will only be used if the User has logged on and if the setting "Apply User's Login" has been specified.
    
    Parameters:
    
    defaultLogin - Name of the LOGIN Object
  - isPasswordNeverExpires
```
public boolean isPasswordNeverExpires()
```
    Returns true if the password never expires. In this case the user never has to change the password. The password "pass" is an exception and must always be changed immediately at the next logon.
    
    Returns:
    
    true if the password never expires, false otherwise
  - setPasswordNeverExpires
```
public void setPasswordNeverExpires(boolean passwordNeverExpires)
```
    Changes the password expiration setting. If the parameter passwordNeverExpires is true the user never has to change the password. The password "pass" is an exception and must always be changed immediately at the next logon.
    
    Parameters:
    
    passwordNeverExpires - true if the password should never expires, false otherwise
  - isIgnoreSSO
```
public boolean isIgnoreSSO()
```
    Returns true if SSO is to be ignored.
    
    Returns:
    
    true if SSO is to be ignored, false otherwise
  - setIgnoreSSO
```
public void setIgnoreSSO(boolean ignoreSSO)
```
    Changes the ignore SSO setting.
    
    Parameters:
    
    ignoreSSO - true if SSO is to be ignored, false otherwise
  - isPasswordChangeRequired
```
public boolean isPasswordChangeRequired()
```
    Returns true if a password change is required for this user.
    
    Returns:
    
    true if the User has to change the password at next login
  - setPasswordChangeRequired
```
public void setPasswordChangeRequired(boolean passwordMustChange)
```
    Changes the setting for a password change.
    
    Parameters:
    
    passwordMustChange - true if the User has to change the password at next login
  - isLDAPConnection
```
public boolean isLDAPConnection()
```
    Returns true if LDAP is enabled for this user.
    
    Returns:
    
    LDAP Connection
  - setLDAPConnection
```
public void setLDAPConnection(boolean ldapConnection)
```
    Enables or disables the LDAP Connection.
    
    Parameters:
    
    ldapConnection - true if LDAP should be enabled for this user.
  - isLDAPConnectionSystem
```
public boolean isLDAPConnectionSystem()
```
    Returns true if LDAP is enabled for the system.
    
    Returns:
    
    LDAP Connection
  - getDistinguishedName
```
public java.lang.String getDistinguishedName()
```
    Returns the distinguished name of this user.
    
    Returns:
    
    Distinguished name
  - setDistinguishedName
```
public void setDistinguishedName(java.lang.String distinguishedName)
```
    Set the distinguished name for the LDAP connection.
    
    Parameters:
    
    distinguishedName - Distinguished name
  - getTimezone
```
public UC4TimezoneName getTimezone()
```
    Returns the TimeZone to be used for this user following System logon. If no TimeZone has been chosen, the client's pre-set TimeZone is used.
    
    Returns:
    
    Name of the timezone object
  - setTimezone
```
public void setTimezone(UC4TimezoneName timezone)
```
    Sets the TimeZone to be used for this user following System logon. If no TimeZone has been chosen, the client's pre-set TimeZone is used.
    
    Parameters:
    
    timezone - Name of the timezone object
  - getValidTimeFrom
```
public Time getValidTimeFrom()
```
    If hasLogonTimeSpan() is true this method returns the lower limit of the allowed logon time.
    
    Returns:
    
    Lower limit of the logon time
  - getValidTimeTo
```
public Time getValidTimeTo()
```
    If hasLogonTimeSpan() is true this method returns the upper limit of the allowed logon time.
    
    Returns:
    
    Upper limit of the logon time
  - hasLogonTimeSpan
```
public boolean hasLogonTimeSpan()
```
    Returns true if a logon time span has been set for this User. Logon is denied when attempted outside of the defined time frame.
    
    Returns:
    
    true if a logon time span is set
  - setLogonTimeSpan
```
public void setLogonTimeSpan(Time from,
                             Time to)
```
    Sets the time span in which a logon is allowed.
    
    Parameters:
    
    from - Lower limit of the logon time
    
    to - Upper limit of the logon time
  - disableLogonTimeSpan
```
public void disableLogonTimeSpan()
```
    Disables the logon time span limitation.
  - setCalendar
```
public void setCalendar(CalendarCondition cond)
```
    Sets the authorization check according to the Calendar. If, during logon, none of the listed Calendars are valid with their Calendar keys, access will be denied
    
    Parameters:
    
    cond - Name and Keyword of a UC4 calendar
  - getCalendar
```
public CalendarCondition getCalendar()
```
    Returns the authorization check according to the Calendar. If, during logon, none of the listed Calendars are valid with their Calendar keys, access will be denied
    
    Returns:
    
    Name and Keyword of a UC4 calendar, never null
  - getMaxParallelSessions
```
public int getMaxParallelSessions()
```
    Returns the maximum number of parallel login sessions a user may have. A value of "0" enables unlimited parallel access frequency.
    
    Returns:
    
    Maximum number of parallel login sessions
  - setMaxParallelSessions
```
public void setMaxParallelSessions(int multiLogon)
```
    Sets the maximum number of parallel login sessions a user may have. A value of "0" enables unlimited parallel access frequency.
    
    Parameters:
    
    multiLogon - Maximum number of parallel login sessions, values from 0 to 9999 are allowed
  - getMinActivityRefresh
```
public int getMinActivityRefresh()
```
    Returns the User-specific minimum interval in seconds for refreshing activities (display refresh). The value "0" signals that no minimum value has been specified.
    
    Returns:
    
    Interval in seconds
  - setMinActivityRefresh
```
public void setMinActivityRefresh(int refresh)
```
    Sets the User-specific minimum interval in seconds for refreshing activities (display refresh). The value "0" signals that no minimum value has been specified.
    
    Parameters:
    
    refresh - Interval in seconds, values from 0 to 999 are allowed

Class UserAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserAttributes

Method Detail

store

setPassword

isActive

setActive

isLocked

setLocked

getFirstName

setFirstName

getLastName

setLastName

getEmail1

setEmail1

getEmail2

setEmail2

getDefaultLogin

setDefaultLogin

isPasswordNeverExpires

setPasswordNeverExpires

isIgnoreSSO

setIgnoreSSO

isPasswordChangeRequired

setPasswordChangeRequired

isLDAPConnection

setLDAPConnection

isLDAPConnectionSystem

getDistinguishedName

setDistinguishedName

getTimezone

setTimezone

getValidTimeFrom

getValidTimeTo

hasLogonTimeSpan

setLogonTimeSpan

disableLogonTimeSpan

setCalendar

getCalendar

getMaxParallelSessions

setMaxParallelSessions

getMinActivityRefresh

setMinActivityRefresh