Package de.uplanet.lucy.server.usermanager.groovy

Class GroovyUser

  • All Implemented Interfaces:
    IUser, ILogonUser
    public final class GroovyUser
extends Object
implements IUser
    A user wrapper class for Groovy scripting.

    Note: Do not store instances of this class for later use by another thread or transaction.

    Since:
    Intrexx 6.0.

    • Method Detail

      • propertyMissing

        public void propertyMissing​(String p_strName,
                            Object p_value)
        For internal use only.

      • getGuid

        public String getGuid()
        Description copied from interface: ILogonUser
        Get the GUID of the user.
        Specified by:
        getGuid in interface ILogonUser
        Returns:
        The user's GUID.

      • getPublicId

        public String getPublicId()
        Description copied from interface: IUser
        Get the user's public ID.

        The public user ID consists of 40 upper-case hexadecimal digits.

        Specified by:
        getPublicId in interface IUser
        Returns:
        The public user ID.

      • getId

        public int getId()
        Note: The use of integer IDs is discouraged in scripts. Objects should normally be identified by their GUIDs.
        Specified by:
        getId in interface IUser

      • setName

        public void setName​(String p_strValue)

      • getClassId

        public int getClassId()
        This property is read-only.
        Specified by:
        getClassId in interface IUser
        Returns:
        The class ID of this object.

      • getContainerId

        public int getContainerId()
        Note: The use of integer IDs is discouraged in scripts. Objects should normally be identified by their GUIDs.
        Specified by:
        getContainerId in interface IUser

      • setContainerGuid

        public void setContainerGuid​(String p_strValue)

      • getDirectMemberSets

        public ModifiableGroovyDsSetNodeCollection getDirectMemberSets()
        A collection of sets this user is direct member of.
        Returns:
        The collection of sets this user is direct member of.

      • getBossId

        public int getBossId()
        Note: The use of integer IDs is discouraged in scripts. Objects should normally be identified by their GUIDs.
        Specified by:
        getBossId in interface IUser

      • setBossId

        public void setBossId​(int p_iValue)
        Note: The use of integer IDs is discouraged in scripts. Objects should normally be identified by their GUIDs.

      • hasBoss

        public boolean hasBoss()
        Specified by:
        hasBoss in interface IUser

      • getBossUser

        public GroovyUser getBossUser()
                       throws de.uplanet.lucy.usermanager.NotFoundException
        Throws:
        de.uplanet.lucy.usermanager.NotFoundException

      • getProxyPersonId

        public int getProxyPersonId()
        Note: The use of integer IDs is discouraged in scripts. Objects should normally be identified by their GUIDs.
        Specified by:
        getProxyPersonId in interface IUser

      • setProxyPersonId

        public void setProxyPersonId​(int p_iValue)
        Note: The use of integer IDs is discouraged in scripts. Objects should normally be identified by their GUIDs.

      • hasProxyPerson

        public boolean hasProxyPerson()
        Specified by:
        hasProxyPerson in interface IUser

      • getProxyPersonUser

        public GroovyUser getProxyPersonUser()
                              throws de.uplanet.lucy.usermanager.NotFoundException
        Throws:
        de.uplanet.lucy.usermanager.NotFoundException

      • getLoginDomain

        public String getLoginDomain()
        Description copied from interface: ILogonUser
        Get the login domain of the user.
        Specified by:
        getLoginDomain in interface ILogonUser
        Returns:
        The user's login domain.

      • setLoginDomain

        public void setLoginDomain​(String p_strValue)

      • getLoginName

        public String getLoginName()
        Description copied from interface: ILogonUser
        Get the login name of the user.
        Specified by:
        getLoginName in interface ILogonUser
        Returns:
        The user's login name.

      • setLoginName

        public void setLoginName​(String p_strValue)

      • isDeleted

        public boolean isDeleted()
        This property is read-only.
        Specified by:
        isDeleted in interface IUser
        Returns:
        true if this user is deleted, or false otherwise.

      • isDeletable

        public boolean isDeletable()
        This property is read-only.
        Specified by:
        isDeletable in interface IUser
        Returns:
        true if this user is deletable, or false otherwise.

      • isDisabled

        public boolean isDisabled()
        Specified by:
        isDisabled in interface IUser

      • setDisabled

        public void setDisabled​(boolean p_bValue)

      • isLockable

        public boolean isLockable()
        Description copied from interface: IUser
        Check if the user account can be locked.
        Specified by:
        isLockable in interface IUser
        Returns:
        true if the user account can be locked, or false otherwise.

      • setLockable

        public void setLockable​(boolean p_bLockable)

      • getLocked

        public int getLocked()
        Description copied from interface: IUser
        Check if the user is locked.
        Specified by:
        getLocked in interface IUser
        Returns:
        0 if the user is not locked, or a value greater than zero if the user is locked.

      • setLocked

        public void setLocked​(int p_iValue)

      • setModifiablePassword

        public void setModifiablePassword​(boolean p_bValue)

      • setMustChangePassword

        public void setMustChangePassword​(boolean p_bValue)

      • setPasswordExpires

        public void setPasswordExpires​(boolean p_bValue)

      • setPasswordChangedDate

        public void setPasswordChangedDate​(Date p_dt)

      • getCannotChange

        @Deprecated
public boolean getCannotChange()
        Deprecated.
        Note: do not use this property in scripts.
        Specified by:
        getCannotChange in interface IUser

      • getPwdExpires

        @Deprecated
public boolean getPwdExpires()
        Deprecated.
        Note: do not use this property in scripts.
        Specified by:
        getPwdExpires in interface IUser

      • getMustChange

        @Deprecated
public boolean getMustChange()
        Deprecated.
        Note: do not use this property in scripts.
        Specified by:
        getMustChange in interface IUser

      • isAnonymous

        public boolean isAnonymous()
        Specified by:
        isAnonymous in interface IUser

      • setEmailBiz

        public void setEmailBiz​(String p_strValue)

      • setEmailHome

        public void setEmailHome​(String p_strValue)

      • setPhoneBiz

        public void setPhoneBiz​(String p_strValue)

      • setPhoneFax

        public void setPhoneFax​(String p_strValue)

      • setPhoneHome

        public void setPhoneHome​(String p_strValue)

      • setPhoneMobileBiz

        public void setPhoneMobileBiz​(String p_strValue)

      • setPhoneMobileHome

        public void setPhoneMobileHome​(String p_strValue)

      • setPhonePager

        public void setPhonePager​(String p_strValue)

      • setBirthday

        public void setBirthday​(Date p_dtValue)

      • setEnterDate

        public void setEnterDate​(Date p_dtValue)

      • setGender

        public void setGender​(int p_iValue)

      • isMale

        public boolean isMale()
        Specified by:
        isMale in interface IUser

      • setMale

        public void setMale​(boolean p_bValue)

      • isFemale

        public boolean isFemale()
        Specified by:
        isFemale in interface IUser

      • setFemale

        public void setFemale​(boolean p_bValue)

      • isDiverse

        public boolean isDiverse()
        Specified by:
        isDiverse in interface IUser

      • setDiverse

        public void setDiverse​(boolean p_bValue)
        Parameters:
        p_bValue - If false, GENDER_UNKNOWN will be set.

      • getMiddleName

        public String getMiddleName()
        Description copied from interface: ILogonUser
        Get the middle name of the user.
        Specified by:
        getMiddleName in interface ILogonUser
        Returns:
        The user's middle name.

      • setMiddleName

        public void setMiddleName​(String p_strValue)

      • setCity

        public void setCity​(String p_strValue)

      • setCountry

        public void setCountry​(String p_strValue)

      • setEmployeeNo

        public void setEmployeeNo​(String p_strValue)

      • getFirstName

        public String getFirstName()
        Description copied from interface: ILogonUser
        Get the first name of the user.
        Specified by:
        getFirstName in interface ILogonUser
        Returns:
        The user's first name.

      • setFirstName

        public void setFirstName​(String p_strValue)

      • getLastName

        public String getLastName()
        Description copied from interface: ILogonUser
        Get the last name of the user.
        Specified by:
        getLastName in interface ILogonUser
        Returns:
        The user's last name.

      • setLastName

        public void setLastName​(String p_strValue)

      • setStreet

        public void setStreet​(String p_strValue)

      • getTitle

        public String getTitle()
        Description copied from interface: ILogonUser
        Get the title of the user.
        Specified by:
        getTitle in interface ILogonUser
        Returns:
        The user's title.

      • setTitle

        public void setTitle​(String p_strValue)

      • setPostalCode

        public void setPostalCode​(String p_strValue)

      • setTimeZone

        public void setTimeZone​(TimeZone p_tz)

      • getTimeZoneId

        public String getTimeZoneId()
        Description copied from interface: ILogonUser
        Get the time zone of the user.
        Specified by:
        getTimeZoneId in interface ILogonUser
        Returns:
        The user's time zone.

      • setTimeZoneId

        public void setTimeZoneId​(String p_strValue)

      • getQualifiedLoginName

        public String getQualifiedLoginName()
        Description copied from interface: ILogonUser
        Get the qualified login name of the user.
        Specified by:
        getQualifiedLoginName in interface ILogonUser
        Returns:
        The user's qualified login name.

      • setQualifiedLoginName

        public void setQualifiedLoginName​(String p_strValue)

      • getFullName

        public String getFullName()
        Description copied from interface: ILogonUser
        Get the full name of the user.
        Specified by:
        getFullName in interface ILogonUser
        Returns:
        The user's full name.

      • setFullName

        public void setFullName​(String p_strValue)

      • setExternalLogin1

        public void setExternalLogin1​(String p_strValue)

      • setExternalLogin2

        public void setExternalLogin2​(String p_strValue)

      • setExternalLogin3

        public void setExternalLogin3​(String p_strValue)

      • setExternalPassword1

        public void setExternalPassword1​(String p_strValue)

      • setExternalPassword2

        public void setExternalPassword2​(String p_strValue)

      • setExternalPassword3

        public void setExternalPassword3​(String p_strValue)

      • getDefaultLanguage

        public String getDefaultLanguage()
        Description copied from interface: IUser
        Get the default language identifier.
        Specified by:
        getDefaultLanguage in interface IUser
        Returns:
        The default language identifier.

      • setDefaultLanguage

        public void setDefaultLanguage​(String p_strValue)

      • getDefaultLocale

        public String getDefaultLocale()
        Description copied from interface: IUser
        Get the default locale identifier.
        Specified by:
        getDefaultLocale in interface IUser
        Returns:
        The default locale identifier.

      • setDefaultLocale

        public void setDefaultLocale​(String p_strValue)

      • getExternalLogin

        public String getExternalLogin​(int p_iIndex)
        Note: do not use this property in scripts.
        Specified by:
        getExternalLogin in interface IUser

      • getExternalPassword

        public String getExternalPassword​(int p_iIndex)
        Note: do not use this property in scripts.
        Specified by:
        getExternalPassword in interface IUser

      • getDefaultLayout

        public String getDefaultLayout()
        Description copied from interface: IUser
        Get the default layout.
        Specified by:
        getDefaultLayout in interface IUser
        Returns:
        The default layout.

      • getDefaultLayoutMobile

        public String getDefaultLayoutMobile()
        Description copied from interface: IUser
        Get the default layout mobile.
        Specified by:
        getDefaultLayoutMobile in interface IUser
        Returns:
        The default layout mobile.

      • setDefaultLayout

        public void setDefaultLayout​(String p_strValue)

      • setUserImageContentType

        public void setUserImageContentType​(String p_strValue)

      • setUserImageFileName

        public void setUserImageFileName​(String p_strValue)

      • setUserImageUrl

        public void setUserImageUrl​(String p_strValue)

      • setUserImageMetaInfo

        public void setUserImageMetaInfo​(String p_strValue)

      • setUserImageLastModified

        public void setUserImageLastModified​(Date p_dt)

      • setPoBox

        public void setPoBox​(String p_strValue)

      • setState

        public void setState​(String p_strValue)

      • setDescription

        public void setDescription​(String p_strValue)

      • getShowUser

        public boolean getShowUser()
        Note: do not use this property in scripts.
        Specified by:
        getShowUser in interface IUser

      • save

        public void save()
        Save the user object to the database.
        Since:
        Intrexx 7.0.

      • toString

        public String toString()
        Returns a string representation of the user object.

        Note that the actual representation may change between different Intrexx versions.

        Overrides:
        toString in class Object
        Returns:
        The string representation of the user object.