GroovyUserWrapper (Intrexx 7 Groovy Documentation)

java.lang.Object
- groovy.lang.GroovyObjectSupport
- - de.uplanet.lucy.server.usermanager.groovy.GroovyUserWrapper

All Implemented Interfaces:: groovy.lang.GroovyObject

public final class GroovyUserWrapper
extends groovy.lang.GroovyObjectSupport

Version:: $Revision: 131668 $

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Date`	`getBirthday()`
`int`	`getBoss()` Deprecated. This method will be removed soon.
`String`	`getCity()`
`int`	`getClassId()`
`Object`	`getContainer()`
`int`	`getContainerId()`
`String`	`getCountry()`
`String`	`getDefaultLanguage()`
`String`	`getDefaultLayout()`
`String`	`getDescription()`
`String`	`getDn()`
`String`	`getEmailBiz()` Get the user's office e-mail address.
`String`	`getEmailHome()` Get the user's private e-mail address.
`String`	`getEmployeeNo()`
`Date`	`getEnterDate()`
`String`	`getExternalLogin(int p_iIndex)`
`String`	`getExternalLogin1()`
`String`	`getExternalLogin2()`
`String`	`getExternalLogin3()`
`String`	`getExternalPassword(int p_iIndex)`
`String`	`getExternalPassword1()`
`String`	`getExternalPassword2()`
`String`	`getExternalPassword3()`
`int`	`getExternalPrimaryGroupId()`
`String`	`getFirstName()`
`String`	`getFullName()`
`int`	`getGender()`
`String`	`getGuid()`
`int`	`getId()` For internal use only.
`int`	`getInternalUsn()`
`String`	`getLastName()`
`int`	`getLocked()`
`int`	`getLoginAttempts()`
`String`	`getLoginDomain()`
`String`	`getLoginDomainLwr()`
`String`	`getLoginName()`
`String`	`getLoginNameLwr()`
`Collection<?>`	`getMemberOf()`
`String`	`getMiddleName()`
`String`	`getName()`
`String`	`getPassword()`
`Date`	`getPasswordChangedDate()`
`String`	`getPasswordHash()`
`String`	`getPhoneBiz()`
`String`	`getPhoneFax()`
`String`	`getPhoneHome()`
`String`	`getPhoneMobileBiz()`
`String`	`getPhoneMobileHome()`
`String`	`getPhonePager()`
`String`	`getPoBox()`
`String`	`getPostalCode()`
`int`	`getPriority()`
`int`	`getProxyPerson()` Deprecated. This method will be removed soon.
`String`	`getQualifiedLoginName()`
`String`	`getRplGuid()`
`String`	`getSalt()`
`boolean`	`getShowUser()`
`String`	`getState()`
`String`	`getStreet()`
`TimeZone`	`getTimeZone()`
`String`	`getTimeZoneId()`
`String`	`getTitle()`
`String`	`getUserImageContentType()`
`File`	`getUserImageFile()`
`String`	`getUserImageMetaInfo()`
`boolean`	`isAnonymous()`
`boolean`	`isDeletable()`
`boolean`	`isDeleted()`
`boolean`	`isDisabled()`
`boolean`	`isExternalLogin1Set()`
`boolean`	`isFemale()`
`boolean`	`isMale()`
`boolean`	`isModifiablePassword()`
`boolean`	`isMustChangePassword()`
`boolean`	`isPasswordExpires()`
`Object`	`propertyMissing(String p_strName)` For internal use only.
`void`	`propertyMissing(String p_strName, Object p_value)` For internal use only.
`void`	`setBirthday(Date p_dtValue)`
`void`	`setBoss(int p_iValue)` Deprecated. Use the GUID variant instead (coming soon).
`void`	`setCity(String p_strValue)`
`void`	`setContainer(Object p_container)`
`void`	`setCountry(String p_strValue)`
`void`	`setDefaultLanguage(String p_strValue)`
`void`	`setDefaultLayout(String p_strValue)`
`void`	`setDeletable(boolean p_bValue)`
`void`	`setDeleted(boolean p_bValue)`
`void`	`setDescription(String p_strValue)`
`void`	`setDisabled(boolean p_bValue)`
`void`	`setDn(String p_strValue)`
`void`	`setEmailBiz(String p_strValue)` Set the user's office e-mail address.
`void`	`setEmailHome(String p_strValue)` Set the user's private e-mail address.
`void`	`setEmployeeNo(String p_strValue)`
`void`	`setEnterDate(Date p_dtValue)`
`void`	`setExternalLogin1(String p_strValue)`
`void`	`setExternalLogin2(String p_strValue)`
`void`	`setExternalLogin3(String p_strValue)`
`void`	`setExternalPassword1(String p_strValue)`
`void`	`setExternalPassword2(String p_strValue)`
`void`	`setExternalPassword3(String p_strValue)`
`void`	`setExternalPrimaryGroupId(int p_iValue)`
`void`	`setFemale(boolean p_bFemale)`
`void`	`setFirstName(String p_strValue)`
`void`	`setFullName(String p_strValue)`
`void`	`setGender(int p_iGender)` Specify the gender.
`void`	`setGuid(String p_strValue)`
`void`	`setId(int p_iUserId)` For internal use only.
`void`	`setInternalUsn(int p_iValue)`
`void`	`setInvalidPassword()` Set an invalid password, and the `password changed date`.
`void`	`setLastName(String p_strValue)`
`void`	`setLocked(int p_iLocked)`
`void`	`setLoginAttempts(int p_iAttempts)`
`void`	`setLoginDomain(String p_strValue)`
`void`	`setLoginDomainLwr(String p_strValue)`
`void`	`setLoginName(String p_strValue)`
`void`	`setLoginNameLwr(String p_strValue)`
`void`	`setMale(boolean p_bMale)`
`void`	`setMemberOf(Collection<?> p_memberOf)`
`void`	`setMiddleName(String p_strValue)`
`void`	`setName(String p_strValue)`
`void`	`setPassword(String p_strPassword)` Set the `password hash`, the `salt`, and the `password changed date`.
`void`	`setPasswordChangedDate(Date p_dtValue)`
`void`	`setPasswordExpires(boolean p_bValue)`
`void`	`setPasswordHash(String p_strValue)`
`void`	`setPhoneBiz(String p_strValue)`
`void`	`setPhoneFax(String p_strValue)`
`void`	`setPhoneHome(String p_strValue)`
`void`	`setPhoneMobileBiz(String p_strValue)`
`void`	`setPhoneMobileHome(String p_strValue)`
`void`	`setPhonePager(String p_strValue)`
`void`	`setPoBox(String p_strValue)`
`void`	`setPostalCode(String p_strValue)`
`void`	`setPriority(int p_iValue)`
`void`	`setProxyPerson(int p_iValue)` Deprecated. Use the GUID variant instead (coming soon).
`void`	`setRplGuid(String p_strValue)`
`void`	`setSalt(String p_strValue)`
`void`	`setShowUser(boolean p_bValue)`
`void`	`setState(String p_strValue)`
`void`	`setStreet(String p_strValue)`
`void`	`setTimeZone(TimeZone p_tz)`
`void`	`setTimeZoneId(String p_strValue)`
`void`	`setTitle(String p_strValue)`
`void`	`setUserImageContentType(String p_strValue)`
`void`	`setUserImageFile(File p_file)`
`void`	`setUserImageMetaInfo(String p_strValue)`

Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

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

Method Detail

propertyMissing

public Object propertyMissing(String p_strName)

For internal use only.

propertyMissing

public void propertyMissing(String p_strName,
                            Object p_value)

For internal use only.

setId
```
public void setId(int p_iUserId)
```
For internal use only.

getId
```
public int getId()
```
For internal use only.

setGuid

public void setGuid(String p_strValue)

getGuid
```
public String getGuid()
```

getClassId
```
public int getClassId()
```

getContainer
```
public Object getContainer()
```

setContainer

public void setContainer(Object p_container)

getContainerId
```
public int getContainerId()
```
Throws:

UnsupportedOperationException - Always since this method is not supported.

See Also:

IUser.getContainerId()

setMemberOf

public void setMemberOf(Collection<?> p_memberOf)

getMemberOf
```
public Collection<?> getMemberOf()
```

setDeletable

public void setDeletable(boolean p_bValue)

setDeleted

public void setDeleted(boolean p_bValue)

setDescription

public void setDescription(String p_strValue)

setDn
```
public void setDn(String p_strValue)
```

getDn
```
public String getDn()
```

setInternalUsn

public void setInternalUsn(int p_iValue)

getInternalUsn
```
public int getInternalUsn()
```

setName

public void setName(String p_strValue)

setPriority

public void setPriority(int p_iValue)

getPriority
```
public int getPriority()
```

setRplGuid

public void setRplGuid(String p_strValue)

getRplGuid
```
public String getRplGuid()
```

setDisabled

public void setDisabled(boolean p_bValue)

isDisabled
```
public boolean isDisabled()
```

isAnonymous
```
public boolean isAnonymous()
```

getDescription
```
public String getDescription()
```

getName
```
public String getName()
```

isDeletable
```
public boolean isDeletable()
```

isDeleted
```
public boolean isDeleted()
```

setBirthday

public void setBirthday(Date p_dtValue)

getBirthday
```
public Date getBirthday()
```

setCity

public void setCity(String p_strValue)

getCity
```
public String getCity()
```

setCountry

public void setCountry(String p_strValue)

getCountry
```
public String getCountry()
```

setDefaultLayout

public void setDefaultLayout(String p_strValue)

getDefaultLayout
```
public String getDefaultLayout()
```

setLoginDomain

public void setLoginDomain(String p_strValue)

getLoginDomain
```
public String getLoginDomain()
```

setLoginDomainLwr

public void setLoginDomainLwr(String p_strValue)

getLoginDomainLwr
```
public String getLoginDomainLwr()
```

setEmployeeNo

public void setEmployeeNo(String p_strValue)

getEmployeeNo
```
public String getEmployeeNo()
```

setEnterDate

public void setEnterDate(Date p_dtValue)

getEnterDate
```
public Date getEnterDate()
```

getExternalLogin

public String getExternalLogin(int p_iIndex)

getExternalPassword

public String getExternalPassword(int p_iIndex)

isExternalLogin1Set
```
public boolean isExternalLogin1Set()
```

setExternalLogin1

public void setExternalLogin1(String p_strValue)

getExternalLogin1
```
public String getExternalLogin1()
```

setExternalLogin2

public void setExternalLogin2(String p_strValue)

getExternalLogin2
```
public String getExternalLogin2()
```

setExternalLogin3

public void setExternalLogin3(String p_strValue)

getExternalLogin3
```
public String getExternalLogin3()
```

setExternalPrimaryGroupId

public void setExternalPrimaryGroupId(int p_iValue)

getExternalPrimaryGroupId

public int getExternalPrimaryGroupId()

setExternalPassword1

public void setExternalPassword1(String p_strValue)

getExternalPassword1
```
public String getExternalPassword1()
```

setExternalPassword2

public void setExternalPassword2(String p_strValue)

getExternalPassword2
```
public String getExternalPassword2()
```

setExternalPassword3

public void setExternalPassword3(String p_strValue)

getExternalPassword3
```
public String getExternalPassword3()
```

setFirstName

public void setFirstName(String p_strValue)

getFirstName
```
public String getFirstName()
```

setFullName

public void setFullName(String p_strValue)

getFullName
```
public String getFullName()
```

setGender
```
public void setGender(int p_iGender)
```
Specify the gender. Valid values are
- 0 unspecified,
- 1 male,
- 2 female.
Parameters:

p_iGender - The gender.

getGender
```
public int getGender()
```

setMale
```
public void setMale(boolean p_bMale)
```

isMale
```
public boolean isMale()
```

setFemale

public void setFemale(boolean p_bFemale)

isFemale
```
public boolean isFemale()
```

setLastName

public void setLastName(String p_strValue)

getLastName
```
public String getLastName()
```

setLoginName

public void setLoginName(String p_strValue)

getLoginName
```
public String getLoginName()
```

setLoginNameLwr

public void setLoginNameLwr(String p_strValue)

getLoginNameLwr
```
public String getLoginNameLwr()
```

setEmailBiz
```
public void setEmailBiz(String p_strValue)
```
Set the user's office e-mail address.

Parameters:

p_strValue - The new value, or null.

Throws:

IllegalArgumentException - if the given value is not a valid e-mail address.

getEmailBiz
```
public String getEmailBiz()
```
Get the user's office e-mail address.

Returns:

The user's office e-mail address.

setEmailHome
```
public void setEmailHome(String p_strValue)
```
Set the user's private e-mail address.

Parameters:

p_strValue - The new value, or null.

Throws:

IllegalArgumentException - if the given value is not a valid e-mail address.

getEmailHome
```
public String getEmailHome()
```
Get the user's private e-mail address.

Returns:

The user's private e-mail address.

setMiddleName

public void setMiddleName(String p_strValue)

getMiddleName
```
public String getMiddleName()
```

setPhoneBiz

public void setPhoneBiz(String p_strValue)

getPhoneBiz
```
public String getPhoneBiz()
```

setPhoneFax

public void setPhoneFax(String p_strValue)

getPhoneFax
```
public String getPhoneFax()
```

setPhoneHome

public void setPhoneHome(String p_strValue)

getPhoneHome
```
public String getPhoneHome()
```

setPhoneMobileHome

public void setPhoneMobileHome(String p_strValue)

getPhoneMobileHome
```
public String getPhoneMobileHome()
```

setPhoneMobileBiz

public void setPhoneMobileBiz(String p_strValue)

getPhoneMobileBiz
```
public String getPhoneMobileBiz()
```

setPhonePager

public void setPhonePager(String p_strValue)

getPhonePager
```
public String getPhonePager()
```

setBoss
```
@Deprecated
public void setBoss(int p_iValue)
```
Deprecated. Use the GUID variant instead (coming soon).

Do not use this method in scripts.

getBoss
```
@Deprecated
public int getBoss()
```
Deprecated. This method will be removed soon.

Do not use this method in scripts.

setPostalCode

public void setPostalCode(String p_strValue)

getPostalCode
```
public String getPostalCode()
```

setProxyPerson
```
@Deprecated
public void setProxyPerson(int p_iValue)
```
Deprecated. Use the GUID variant instead (coming soon).

Do not use this method in scripts.

getProxyPerson
```
@Deprecated
public int getProxyPerson()
```
Deprecated. This method will be removed soon.

Do not use this method in scripts.

setInvalidPassword
```
public void setInvalidPassword()
```
Set an invalid password, and the password changed date.

setPassword
```
public void setPassword(String p_strPassword)
                 throws UnsupportedEncodingException
```
Set the password hash, the salt, and the password changed date.

Throws:

UnsupportedEncodingException

getPassword
```
public String getPassword()
```

setPasswordHash

public void setPasswordHash(String p_strValue)

getPasswordHash
```
public String getPasswordHash()
```

setSalt

public void setSalt(String p_strValue)

getSalt
```
public String getSalt()
```

setPasswordExpires

public void setPasswordExpires(boolean p_bValue)

isPasswordExpires
```
public boolean isPasswordExpires()
```

isModifiablePassword
```
public boolean isModifiablePassword()
```

isMustChangePassword
```
public boolean isMustChangePassword()
```

setPasswordChangedDate

public void setPasswordChangedDate(Date p_dtValue)

getPasswordChangedDate
```
public Date getPasswordChangedDate()
```

setShowUser

public void setShowUser(boolean p_bValue)

getShowUser
```
public boolean getShowUser()
```

setStreet

public void setStreet(String p_strValue)

getStreet
```
public String getStreet()
```

setTimeZone

public void setTimeZone(TimeZone p_tz)

getTimeZone
```
public TimeZone getTimeZone()
```

setTimeZoneId

public void setTimeZoneId(String p_strValue)

getTimeZoneId
```
public String getTimeZoneId()
```

setTitle

public void setTitle(String p_strValue)

getTitle
```
public String getTitle()
```

setUserImageFile

public void setUserImageFile(File p_file)

getUserImageFile
```
public File getUserImageFile()
```

setUserImageContentType

public void setUserImageContentType(String p_strValue)

getUserImageContentType

public String getUserImageContentType()

setUserImageMetaInfo

public void setUserImageMetaInfo(String p_strValue)

getUserImageMetaInfo
```
public String getUserImageMetaInfo()
```

getState
```
public String getState()
```

setState

public void setState(String p_strValue)

getPoBox
```
public String getPoBox()
```

setPoBox

public void setPoBox(String p_strValue)

getDefaultLanguage
```
public String getDefaultLanguage()
```

setDefaultLanguage

public void setDefaultLanguage(String p_strValue)

getQualifiedLoginName
```
public String getQualifiedLoginName()
```

getLoginAttempts
```
public int getLoginAttempts()
```

setLoginAttempts

public void setLoginAttempts(int p_iAttempts)

getLocked
```
public int getLocked()
```

setLocked
```
public void setLocked(int p_iLocked)
```

Class GroovyUserWrapper

Method Summary

Methods inherited from class groovy.lang.GroovyObjectSupport

Methods inherited from class java.lang.Object

Method Detail

propertyMissing

propertyMissing

setId

getId

setGuid

getGuid

getClassId

getContainer

setContainer

getContainerId

setMemberOf

getMemberOf

setDeletable

setDeleted

setDescription

setDn

getDn

setInternalUsn

getInternalUsn

setName

setPriority

getPriority

setRplGuid

getRplGuid

setDisabled

isDisabled

isAnonymous

getDescription

getName

isDeletable

isDeleted

setBirthday

getBirthday

setCity

getCity

setCountry

getCountry

setDefaultLayout

getDefaultLayout

setLoginDomain

getLoginDomain

setLoginDomainLwr

getLoginDomainLwr

setEmployeeNo

getEmployeeNo

setEnterDate

getEnterDate

getExternalLogin

getExternalPassword

isExternalLogin1Set

setExternalLogin1

getExternalLogin1

setExternalLogin2

getExternalLogin2

setExternalLogin3

getExternalLogin3

setExternalPrimaryGroupId

getExternalPrimaryGroupId

setExternalPassword1

getExternalPassword1

setExternalPassword2

getExternalPassword2

setExternalPassword3

getExternalPassword3

setFirstName

getFirstName

setFullName

getFullName

setGender

getGender

setMale

isMale

setFemale

isFemale

setLastName