com.businessobjects.enterprise.user
Interface User

All Superinterfaces:

InfoObject

public interface User
extends InfoObject

The User class is used to determine the specific behavior of each user. It is the top level object in the User plugin.

Use the User class to change the password settings for a specific user. Password options for third-party accounts are set through your external systems.

Nested Class Summary

Nested classes/interfaces inherited from interface com.businessobjects.enterprise.infoobject.InfoObject

InfoObject.Factory

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

UserAliases	addNewAliases() Appends and returns a new empty UserAliases object as the last element of the array.
CustomProperties	addNewCustomProperties() Appends and returns a new empty CustomProperties object as the last element of the array.
EntGroups	addNewEntGroups() Appends and returns a new empty EntGroups element
ExcludedPublications	addNewExcludedPublications() Appends and returns a new empty ExcludedPublications object as the last element of the array.
com.businessobjects.enterprise.user.User.FavoritesFolder	addNewFavoritesFolder() Appends and returns a new empty FavoritesFolder element.
Groups	addNewGroups() Appends and returns a new empty Groups object as the last element of the array.
com.businessobjects.enterprise.user.User.Inbox	addNewInbox() Appends and returns a new empty Inbox element.
com.businessobjects.enterprise.user.User.PersonalCategory	addNewPersonalCategory() Appends and returns a new empty PersonalCategory element.
PrincipalProfiles	addNewPrincipalProfiles() Appends and returns a new empty PrincipalProfiles object as the last element of the array.
PrincipalPublications	addNewPrincipalPublications() Appends and returns a new empty PrincipalPublications object as the last element of the array.
ProfileValues	addNewProfileValues() Appends and returns a new empty ProfileValues object as the last element of the array.
SecondaryCredentials	addNewSecondaryCredentials() Appends and returns a new empty SecondaryCredentials object as the last element of the array.
UserProfiles	addNewUserProfiles() Appends and returns a new empty UserProfiles object as the last element of the array.
UserAliases	getAliases() Returns the collection of aliases for this user.
boolean	getAttributeImportingEnabled() Gets the AttributeImportingEnabled element
CustomProperties	getCustomProperties() Returns the custom properties.
java.lang.String	getE65Cuid() Internal Use Only.
java.lang.String	getEmailAddress() Gets user's email address.
EntGroups	getEntGroups() Gets the EntGroups element.
ExcludedPublications	getExcludedPublications() Returns the collection of excluded publication IDs for this user.
int	getFailedLogons() Gets the number of failed logon attempts since the last successful logon.
com.businessobjects.enterprise.user.User.FavoritesFolder	getFavoritesFolder() Gets the FavoritesFolder element.
java.lang.String	getFullName() Returns the full name of the user.
Groups	getGroups() Returns a collection of the groups that the user belongs to.
com.businessobjects.enterprise.user.User.Inbox	getInbox() Gets the Inbox element
java.util.Calendar	getLastLogonTime() Gets the last date and time this user connected to the CMS.
java.util.Calendar	getLastPasswordChangeTime() Returns the last password change time.
boolean	getNamedUser() Gets if the license being used is named or concurrent.
java.lang.String	getPassword() Internal Use Only.
boolean	getPasswordChangeAllowed() Returns whether the user is allowed to change their password.
boolean	getPasswordExpiryAllowed() Returns whether the password expires.
boolean	getPasswordToChangeAtNextLogon() Returns whether the user must change their password at the next logon.
com.businessobjects.enterprise.user.User.PersonalCategory	getPersonalCategory() Gets the PersonalCategory element.
PrincipalProfiles	getPrincipalProfiles() Returns a collection of profile values associated with this principal.
PrincipalPublications	getPrincipalPublications() Returns the collection of publication IDs for this user.
ProfileValues	getProfileValues() Returns the collection of profile values for this user.
SecondaryCredentials	getSecondaryCredentials() Returns the specified secondary credential.
int	getUserFlags() Internal Use Only.
UserProfiles	getUserProfiles() Returns a collection of profile values for this user.
boolean	isSetAliases() Checks if the Aliases element has been set.
boolean	isSetAttributeImportingEnabled() Checks if the AttributeImportingEnabled element has been set.
boolean	isSetCustomProperties() Checks if the custom properties have been set.
boolean	isSetE65Cuid() Internal Use Only.
boolean	isSetEmailAddress() Checks if the email address for this user has been set.
boolean	isSetExcludedPublications() Checks if the collection of excluded publication IDs for this user has been set.
boolean	isSetFailedLogons() Internal Use Only.
boolean	isSetFavoritesFolder() Checks if the FavoritesFolder element has been set
boolean	isSetFullName() Checks if the full name of the user has been set.
boolean	isSetInbox() Checks if the Inbox element has been set.
boolean	isSetLastLogonTime() Internal Use Only.
boolean	isSetLastPasswordChangeTime() Internal Use Only.
boolean	isSetPassword() Internal Use Only.
boolean	isSetPasswordChangeAllowed() Checks if the ability for the user to change their password has been set.
boolean	isSetPasswordExpiryAllowed() Checks if the ability for the password to expire has been set.
boolean	isSetPasswordToChangeAtNextLogon() Checks if whether the user must change their password at the next logon has been set.
boolean	isSetPersonalCategory() Checks if the PersonalCategory element has been set
boolean	isSetPrincipalProfiles() Checks if the collection of profile values associated with this principal has been set.
boolean	isSetPrincipalPublications() Checks if the collection of publication IDs for this user has been set.
boolean	isSetProfileValues() Checks if the collection of profile values for this user has been set.
boolean	isSetSecondaryCredentials() Checks if the secondary credential has been set.
boolean	isSetUserFlags() Internal Use Only.
boolean	isSetUserProfiles() Checks if the collection of profile values for this user has been set.
void	setAliases(UserAliases aliases) Sets the collection of aliases for this user.
void	setAttributeImportingEnabled(boolean attributeImportingEnabled) Sets the AttributeImportingEnabled element.
void	setCustomProperties(CustomProperties customProperties) Sets the custom properties.
void	setE65Cuid(java.lang.String e65Cuid) Internal Use Only.
void	setEmailAddress(java.lang.String emailAddress) Sets user's email address.
void	setEntGroups(EntGroups entGroups) Sets the EntGroups element.
void	setExcludedPublications(ExcludedPublications excludedPublications) Sets the collection of excluded publication IDs for this user.
void	setFailedLogons(int failedLogons) Internal Use Only.
void	setFavoritesFolder(com.businessobjects.enterprise.user.User.FavoritesFolder favoritesFolder) Sets the FavoritesFolder element.
void	setFullName(java.lang.String fullName) Sets the full name of the user.
void	setGroups(Groups groups) Sets a collection of the groups that the user belongs to.
void	setInbox(com.businessobjects.enterprise.user.User.Inbox inbox) Sets the Inbox element.
void	setLastLogonTime(java.util.Calendar lastLogonTime) Internal Use Only.
void	setLastPasswordChangeTime(java.util.Calendar lastPasswordChangeTime) Internal Use Only.
void	setNamedUser(boolean namedUser) Sets if the license being used is named or concurrent.
void	setPassword(java.lang.String password) Sets a new password without requiring an old password.
void	setPasswordChangeAllowed(boolean passwordChangeAllowed) Allows the user to change his or her password.
void	setPasswordExpiryAllowed(boolean passwordExpiryAllowed) Sets whether the password expires.
void	setPasswordToChangeAtNextLogon(boolean passwordToChangeAtNextLogon) Forces the user to change the password at the next logon.
void	setPersonalCategory(com.businessobjects.enterprise.user.User.PersonalCategory personalCategory) Sets the PersonalCategory element.
void	setPrincipalProfiles(PrincipalProfiles principalProfiles) Sets a collection of profile values associated with this principal.
void	setPrincipalPublications(PrincipalPublications principalPublications) Sets the collection of publication IDs for this user.
void	setProfileValues(ProfileValues profileValues) Sets the collection of profile values for this user.
void	setSecondaryCredentials(SecondaryCredentials secondaryCredentials) Set the new value to the specified secondary credential or create a new one if the credential specified does not exist.
void	setUserFlags(int userFlags) Internal Use Only.
void	setUserProfiles(UserProfiles userProfiles) Sets a collection of profile values for this user.
void	unsetAliases() Deletes or unsets the Aliases element.
void	unsetAttributeImportingEnabled() Deletes or unsets the AttributeImportingEnabled element
void	unsetCustomProperties() Deletes or unsets the CustomProperties element.
void	unsetE65Cuid() Internal Use Only.
void	unsetEmailAddress() Deletes or unsets the EmailAddress element.
void	unsetExcludedPublications() Deletes or unsets the ExcludedPublications element.
void	unsetFailedLogons() Internal Use Only.
void	unsetFavoritesFolder() Deletes or unsets the FavoritesFolder element
void	unsetFullName() Deletes or unsets the FullName element.
void	unsetInbox() Deletes or unsets the Inbox element
void	unsetLastLogonTime() Internal Use Only.
void	unsetLastPasswordChangeTime() Internal Use Only.
void	unsetPassword() Internal Use Only.
void	unsetPasswordChangeAllowed() Deletes or unsets the PasswordChangeAllowed element.
void	unsetPasswordExpiryAllowed() Deletes or unsets the PasswordExpiryAllowed element.
void	unsetPasswordToChangeAtNextLogon() Deletes or unsets the PasswordToChangeAtNextLogon element.
void	unsetPersonalCategory() Deletes or unsets the PersonalCategory element
void	unsetPrincipalProfiles() Deletes or unsets the PrincipalProfiles element.
void	unsetPrincipalPublications() Delets or unsets the PrincipalPublications element.
void	unsetProfileValues() Deletes or unsets the ProfileValues element.
void	unsetSecondaryCredentials() Deletes or unsets the SecondaryCredentials element.
void	unsetUserFlags() Internal Use Only.
void	unsetUserProfiles() Deletes or unsets the UserProfiles element.
org.apache.xmlbeans.XmlBoolean	xgetAttributeImportingEnabled() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetE65Cuid() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetEmailAddress() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetFailedLogons() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFullName() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastLogonTime() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastPasswordChangeTime() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetNamedUser() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPassword() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPasswordChangeAllowed() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPasswordExpiryAllowed() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPasswordToChangeAtNextLogon() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetUserFlags() Internal Use Only.
void	xsetAttributeImportingEnabled(org.apache.xmlbeans.XmlBoolean attributeImportingEnabled) Internal Use Only.
void	xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid) Internal Use Only.
void	xsetEmailAddress(org.apache.xmlbeans.XmlString emailAddress) Internal Use Only.
void	xsetFailedLogons(org.apache.xmlbeans.XmlInt failedLogons) Internal Use Only.
void	xsetFullName(org.apache.xmlbeans.XmlString fullName) Internal Use Only.
void	xsetLastLogonTime(org.apache.xmlbeans.XmlDateTime lastLogonTime) Internal Use Only.
void	xsetLastPasswordChangeTime(org.apache.xmlbeans.XmlDateTime lastPasswordChangeTime) Internal Use Only.
void	xsetNamedUser(org.apache.xmlbeans.XmlBoolean namedUser) Internal Use Only.
void	xsetPassword(org.apache.xmlbeans.XmlString password) Internal Use Only.
void	xsetPasswordChangeAllowed(org.apache.xmlbeans.XmlBoolean passwordChangeAllowed) Internal Use Only.
void	xsetPasswordExpiryAllowed(org.apache.xmlbeans.XmlBoolean passwordExpiryAllowed) Internal Use Only.
void	xsetPasswordToChangeAtNextLogon(org.apache.xmlbeans.XmlBoolean passwordToChangeAtNextLogon) Internal Use Only.
void	xsetUserFlags(org.apache.xmlbeans.XmlInt userFlags) Internal Use Only.

Methods inherited from interface com.businessobjects.enterprise.infoobject.InfoObject

addNewAlerts, addNewPluginInfo, addNewRolesOnObject, addNewSecurityInfo, addNewSecurityInfo2, addNewSharedDoc, addNewStatusInfo, getAlerts, getChildrenObjects, getCreationTime, getCUID, getDescription, getEndTime, getErrorMessage, getID, getInstance, getInstanceObject, getIsApplicationObject, getIsComponent, getIsHiddenObject, getIsPluginObject, getIsRecurring, getIsRunnableObject, getIsSendable, getIsSystemObject, getKey, getKeywords, getKind, getLastRunTime, getLastSuccessfulInstanceCUID, getName, getNewJobID, getNextRunTime, getObjectIsContainer, getOwner, getOwnerCUID, getParentCUID, getPluginInfo, getRolesOnObject, getRUID, getSchedulable, getSecurityInfo, getSecurityInfo2, getSharedDoc, getStartTime, getStatusInfo, getUiStatus, getUpdateTime, isSetAlerts, isSetChildrenObjects, isSetCreationTime, isSetCUID, isSetDescription, isSetEndTime, isSetErrorMessage, isSetID, isSetInstance, isSetInstanceObject, isSetIsApplicationObject, isSetIsComponent, isSetIsHiddenObject, isSetIsPluginObject, isSetIsRecurring, isSetIsRunnableObject, isSetIsSendable, isSetIsSystemObject, isSetKey, isSetKeywords, isSetKind, isSetLastRunTime, isSetLastSuccessfulInstanceCUID, isSetNewJobID, isSetNextRunTime, isSetObjectIsContainer, isSetOwner, isSetOwnerCUID, isSetParentCUID, isSetPluginInfo, isSetRolesOnObject, isSetRUID, isSetSchedulable, isSetSecurityInfo, isSetSecurityInfo2, isSetSharedDoc, isSetStartTime, isSetStatusInfo, isSetUiStatus, isSetUpdateTime, setAlerts, setChildrenObjects, setCreationTime, setCUID, setDescription, setEndTime, setErrorMessage, setID, setInstance, setInstanceObject, setIsApplicationObject, setIsComponent, setIsHiddenObject, setIsPluginObject, setIsRecurring, setIsRunnableObject, setIsSendable, setIsSystemObject, setKey, setKeywords, setKind, setLastRunTime, setLastSuccessfulInstanceCUID, setName, setNewJobID, setNextRunTime, setObjectIsContainer, setOwner, setOwnerCUID, setParentCUID, setPluginInfo, setRolesOnObject, setRUID, setSchedulable, setSecurityInfo, setSecurityInfo2, setSharedDoc, setStartTime, setStatusInfo, setUiStatus, setUpdateTime, unsetAlerts, unsetChildrenObjects, unsetCreationTime, unsetCUID, unsetDescription, unsetEndTime, unsetErrorMessage, unsetID, unsetInstance, unsetInstanceObject, unsetIsApplicationObject, unsetIsComponent, unsetIsHiddenObject, unsetIsPluginObject, unsetIsRecurring, unsetIsRunnableObject, unsetIsSendable, unsetIsSystemObject, unsetKey, unsetKeywords, unsetKind, unsetLastRunTime, unsetLastSuccessfulInstanceCUID, unsetNewJobID, unsetNextRunTime, unsetObjectIsContainer, unsetOwner, unsetOwnerCUID, unsetParentCUID, unsetPluginInfo, unsetRolesOnObject, unsetRUID, unsetSchedulable, unsetSecurityInfo, unsetSecurityInfo2, unsetSharedDoc, unsetStartTime, unsetStatusInfo, unsetUiStatus, unsetUpdateTime, xgetChildrenObjects, xgetCreationTime, xgetCUID, xgetDescription, xgetEndTime, xgetErrorMessage, xgetID, xgetInstance, xgetInstanceObject, xgetIsApplicationObject, xgetIsComponent, xgetIsHiddenObject, xgetIsPluginObject, xgetIsRecurring, xgetIsRunnableObject, xgetIsSendable, xgetIsSystemObject, xgetKey, xgetKeywords, xgetKind, xgetLastRunTime, xgetLastSuccessfulInstanceCUID, xgetName, xgetNewJobID, xgetNextRunTime, xgetObjectIsContainer, xgetOwner, xgetOwnerCUID, xgetParentCUID, xgetRUID, xgetSchedulable, xgetStartTime, xgetUiStatus, xgetUpdateTime, xsetChildrenObjects, xsetCreationTime, xsetCUID, xsetDescription, xsetEndTime, xsetErrorMessage, xsetID, xsetInstance, xsetInstanceObject, xsetIsApplicationObject, xsetIsComponent, xsetIsHiddenObject, xsetIsPluginObject, xsetIsRecurring, xsetIsRunnableObject, xsetIsSendable, xsetIsSystemObject, xsetKey, xsetKeywords, xsetKind, xsetLastRunTime, xsetLastSuccessfulInstanceCUID, xsetName, xsetNewJobID, xsetNextRunTime, xsetObjectIsContainer, xsetOwner, xsetOwnerCUID, xsetParentCUID, xsetRUID, xsetSchedulable, xsetStartTime, xsetUiStatus, xsetUpdateTime

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getAliases

UserAliases getAliases()

Returns the collection of aliases for this user.

Returns:

The collection of aliases for this user.

isSetAliases

boolean isSetAliases()

Checks if the Aliases element has been set.

Returns:

true if the PersonalCategories element has been set,otherwise false.

setAliases

void setAliases(UserAliases aliases)

Sets the collection of aliases for this user.

Parameters:

aliases - The collection of aliases for this user.

addNewAliases

UserAliases addNewAliases()

Appends and returns a new empty UserAliases object as the last element of the array. This UserAliases object is a collection of new aliases to be added for this user.

Returns:

A new UserAliases object.

unsetAliases

void unsetAliases()

Deletes or unsets the Aliases element.

getFailedLogons

int getFailedLogons()

Gets the number of failed logon attempts since the last successful logon.

Returns:

The number of failed logon attempts since the last successful logon.

xgetFailedLogons

org.apache.xmlbeans.XmlInt xgetFailedLogons()

Internal Use Only.

isSetFailedLogons

boolean isSetFailedLogons()

Internal Use Only.

setFailedLogons

void setFailedLogons(int failedLogons)

Internal Use Only.

xsetFailedLogons

void xsetFailedLogons(org.apache.xmlbeans.XmlInt failedLogons)

Internal Use Only.

unsetFailedLogons

void unsetFailedLogons()

Internal Use Only.

getExcludedPublications

ExcludedPublications getExcludedPublications()

Returns the collection of excluded publication IDs for this user.

Returns:

The collection of excluded publication IDs for this user.

isSetExcludedPublications

boolean isSetExcludedPublications()

Checks if the collection of excluded publication IDs for this user has been set.

Returns:

true if ExcludedPublications has been set, false otherwise.

setExcludedPublications

void setExcludedPublications(ExcludedPublications excludedPublications)

Sets the collection of excluded publication IDs for this user.

Parameters:

excludedPublications - The collection of excluded publication IDs for this user.

addNewExcludedPublications

ExcludedPublications addNewExcludedPublications()

Appends and returns a new empty ExcludedPublications object as the last element of the array. This ExcludedPublications object is a collection of new excluded publications IDs for this user.

Returns:

A new ExcludedPublications object.

unsetExcludedPublications

void unsetExcludedPublications()

Deletes or unsets the ExcludedPublications element.

getEmailAddress

java.lang.String getEmailAddress()

Gets user's email address.

Returns:

User's email address as a String.

xgetEmailAddress

org.apache.xmlbeans.XmlString xgetEmailAddress()

Internal Use Only.

isSetEmailAddress

boolean isSetEmailAddress()

Checks if the email address for this user has been set.

Returns:

true if the email address has been set, otherwsie false.

setEmailAddress

void setEmailAddress(java.lang.String emailAddress)

Sets user's email address.

Parameters:

emailAddress - User's email address.

xsetEmailAddress

void xsetEmailAddress(org.apache.xmlbeans.XmlString emailAddress)

Internal Use Only.

unsetEmailAddress

void unsetEmailAddress()

Deletes or unsets the EmailAddress element.

getLastLogonTime

java.util.Calendar getLastLogonTime()

Gets the last date and time this user connected to the CMS.

Returns:

The last date and time this user connected to the CMS.

xgetLastLogonTime

org.apache.xmlbeans.XmlDateTime xgetLastLogonTime()

Internal Use Only.

isSetLastLogonTime

boolean isSetLastLogonTime()

Internal Use Only.

setLastLogonTime

void setLastLogonTime(java.util.Calendar lastLogonTime)

Internal Use Only.

xsetLastLogonTime

void xsetLastLogonTime(org.apache.xmlbeans.XmlDateTime lastLogonTime)

Internal Use Only.

unsetLastLogonTime

void unsetLastLogonTime()

Internal Use Only.

getFullName

java.lang.String getFullName()

Returns the full name of the user.

Returns:

A String containing the full name of the user.

xgetFullName

org.apache.xmlbeans.XmlString xgetFullName()

Internal Use Only.

isSetFullName

boolean isSetFullName()

Checks if the full name of the user has been set.

Returns:

true if the FullName element has been set,otherwise false.

setFullName

void setFullName(java.lang.String fullName)

Sets the full name of the user.

Parameters:

fullName - A String containing the full name of the user.

xsetFullName

void xsetFullName(org.apache.xmlbeans.XmlString fullName)

Internal Use Only.

unsetFullName

void unsetFullName()

Deletes or unsets the FullName element.

getPasswordChangeAllowed

boolean getPasswordChangeAllowed()

Returns whether the user is allowed to change their password.

Returns:

true if the user is allowed to change their password, false otherwise.

xgetPasswordChangeAllowed

org.apache.xmlbeans.XmlBoolean xgetPasswordChangeAllowed()

Internal Use Only.

isSetPasswordChangeAllowed

boolean isSetPasswordChangeAllowed()

Checks if the ability for the user to change their password has been set.

Returns:

true if the PasswordChangeAllowed element has been set,otherwise false.

setPasswordChangeAllowed

void setPasswordChangeAllowed(boolean passwordChangeAllowed)

Allows the user to change his or her password.

Parameters:

passwordChangeAllowed - true if the user is allowed to change their password, false otherwise.

xsetPasswordChangeAllowed

void xsetPasswordChangeAllowed(org.apache.xmlbeans.XmlBoolean passwordChangeAllowed)

Internal Use Only.

unsetPasswordChangeAllowed

void unsetPasswordChangeAllowed()

Deletes or unsets the PasswordChangeAllowed element.

getProfileValues

ProfileValues getProfileValues()

Returns the collection of profile values for this user.

Returns:

The collection of profile values for this user.

isSetProfileValues

boolean isSetProfileValues()

Checks if the collection of profile values for this user has been set.

Returns:

true if the ProfileValues element has been set,otherwise false.

setProfileValues

void setProfileValues(ProfileValues profileValues)

Sets the collection of profile values for this user.

Parameters:

profileValues - The collection of profile values for this user.

addNewProfileValues

ProfileValues addNewProfileValues()

Appends and returns a new empty ProfileValues object as the last element of the array.

Returns:

A new ProfileValues object.

unsetProfileValues

void unsetProfileValues()

Deletes or unsets the ProfileValues element.

getPrincipalPublications

PrincipalPublications getPrincipalPublications()

Returns the collection of publication IDs for this user.

Returns:

The collection of publication IDs for this user.

isSetPrincipalPublications

boolean isSetPrincipalPublications()

Checks if the collection of publication IDs for this user has been set.

Returns:

true if the PrincipalPublications element has been set,otherwise false.

setPrincipalPublications

void setPrincipalPublications(PrincipalPublications principalPublications)

Sets the collection of publication IDs for this user.

Parameters:

principalPublications - The collection of publication IDs for this user.

addNewPrincipalPublications

PrincipalPublications addNewPrincipalPublications()

Appends and returns a new empty PrincipalPublications object as the last element of the array. This PrincipalPublications object is a collection of publication IDs for this user.

Returns:

A new PrincipalPublications object.

unsetPrincipalPublications

void unsetPrincipalPublications()

Delets or unsets the PrincipalPublications element.

getGroups

Groups getGroups()

Returns a collection of the groups that the user belongs to.

Returns:

A collection of the groups that the user belongs to.

setGroups

void setGroups(Groups groups)

Sets a collection of the groups that the user belongs to.

Parameters:

groups - A collection of the groups that the user belongs to.

addNewGroups

Groups addNewGroups()

Appends and returns a new empty Groups object as the last element of the array. This Groups object is a collection of the groups that the user belongs to.

Returns:

A new Groups object.

getEntGroups

EntGroups getEntGroups()

Gets the EntGroups element.

Returns:

The EntGroups element.

setEntGroups

void setEntGroups(EntGroups entGroups)

Sets the EntGroups element.

Parameters:

entGroups -

addNewEntGroups

EntGroups addNewEntGroups()

Appends and returns a new empty EntGroups element

Returns:

A new empty EntGroups object.

getPasswordExpiryAllowed

boolean getPasswordExpiryAllowed()

Returns whether the password expires.

Returns:

true if the password expires, false otherwise.

xgetPasswordExpiryAllowed

org.apache.xmlbeans.XmlBoolean xgetPasswordExpiryAllowed()

Internal Use Only.

isSetPasswordExpiryAllowed

boolean isSetPasswordExpiryAllowed()

Checks if the ability for the password to expire has been set.

Returns:

true if the PasswordExpiryAllowed element has been set,otherwise false.

setPasswordExpiryAllowed

void setPasswordExpiryAllowed(boolean passwordExpiryAllowed)

Sets whether the password expires.

Parameters:

passwordExpiryAllowed - true if the password expires, false otherwise.

xsetPasswordExpiryAllowed

void xsetPasswordExpiryAllowed(org.apache.xmlbeans.XmlBoolean passwordExpiryAllowed)

Internal Use Only.

unsetPasswordExpiryAllowed

void unsetPasswordExpiryAllowed()

Deletes or unsets the PasswordExpiryAllowed element.

getPasswordToChangeAtNextLogon

boolean getPasswordToChangeAtNextLogon()

Returns whether the user must change their password at the next logon.

Returns:

true if the user must change their password at next logon, false otherwise.

xgetPasswordToChangeAtNextLogon

org.apache.xmlbeans.XmlBoolean xgetPasswordToChangeAtNextLogon()

Internal Use Only.

isSetPasswordToChangeAtNextLogon

boolean isSetPasswordToChangeAtNextLogon()

Checks if whether the user must change their password at the next logon has been set.

Returns:

true if the PasswordToChangeAtNextLogon element has been set,otherwise false.

setPasswordToChangeAtNextLogon

void setPasswordToChangeAtNextLogon(boolean passwordToChangeAtNextLogon)

Forces the user to change the password at the next logon.

Parameters:

passwordToChangeAtNextLogon - true if the user must change their password at next logon, false otherwise.

xsetPasswordToChangeAtNextLogon

void xsetPasswordToChangeAtNextLogon(org.apache.xmlbeans.XmlBoolean passwordToChangeAtNextLogon)

Internal Use Only.

unsetPasswordToChangeAtNextLogon

void unsetPasswordToChangeAtNextLogon()

Deletes or unsets the PasswordToChangeAtNextLogon element.

getPassword

java.lang.String getPassword()

Internal Use Only.

xgetPassword

org.apache.xmlbeans.XmlString xgetPassword()

Internal Use Only.

isSetPassword

boolean isSetPassword()

Internal Use Only.

setPassword

void setPassword(java.lang.String password)

Sets a new password without requiring an old password. This is an administrative function that allows a password to be set without supplying an old password.

Parameters:

password - A String containing the new password.

xsetPassword

void xsetPassword(org.apache.xmlbeans.XmlString password)

Internal Use Only.

unsetPassword

void unsetPassword()

Internal Use Only.

getLastPasswordChangeTime

java.util.Calendar getLastPasswordChangeTime()

Returns the last password change time.

Returns:

The last password change time.

xgetLastPasswordChangeTime

org.apache.xmlbeans.XmlDateTime xgetLastPasswordChangeTime()

Internal Use Only.

isSetLastPasswordChangeTime

boolean isSetLastPasswordChangeTime()

Internal Use Only.

setLastPasswordChangeTime

void setLastPasswordChangeTime(java.util.Calendar lastPasswordChangeTime)

Internal Use Only.

xsetLastPasswordChangeTime

void xsetLastPasswordChangeTime(org.apache.xmlbeans.XmlDateTime lastPasswordChangeTime)

Internal Use Only.

unsetLastPasswordChangeTime

void unsetLastPasswordChangeTime()

Internal Use Only.

getNamedUser

boolean getNamedUser()

Gets if the license being used is named or concurrent.

Returns:

true if the license being used is named, and false if it is concurrent.

xgetNamedUser

org.apache.xmlbeans.XmlBoolean xgetNamedUser()

Internal Use Only.

setNamedUser

void setNamedUser(boolean namedUser)

Sets if the license being used is named or concurrent.

Parameters:

namedUser - true if the license being used is named, and false if it is concurrent.

xsetNamedUser

void xsetNamedUser(org.apache.xmlbeans.XmlBoolean namedUser)

Internal Use Only.

getPrincipalProfiles

PrincipalProfiles getPrincipalProfiles()

Returns a collection of profile values associated with this principal.

Returns:

A collection of profile values associated with this principal.

isSetPrincipalProfiles

boolean isSetPrincipalProfiles()

Checks if the collection of profile values associated with this principal has been set.

Returns:

true if the collection of profile values associated with this principal has been set, false otherwise.

setPrincipalProfiles

void setPrincipalProfiles(PrincipalProfiles principalProfiles)

Sets a collection of profile values associated with this principal.

Parameters:

principalProfiles - A collection of profile values associated with this principal.

addNewPrincipalProfiles

PrincipalProfiles addNewPrincipalProfiles()

Appends and returns a new empty PrincipalProfiles object as the last element of the array. This PrincipalProfiles object is a collection of profile values that can be associated with this principal.

Returns:

A new PrincipalProfiles object.

unsetPrincipalProfiles

void unsetPrincipalProfiles()

Deletes or unsets the PrincipalProfiles element.

getUserFlags

int getUserFlags()

Internal Use Only.

xgetUserFlags

org.apache.xmlbeans.XmlInt xgetUserFlags()

Internal Use Only.

isSetUserFlags

boolean isSetUserFlags()

Internal Use Only.

setUserFlags

void setUserFlags(int userFlags)

Internal Use Only.

xsetUserFlags

void xsetUserFlags(org.apache.xmlbeans.XmlInt userFlags)

Internal Use Only.

unsetUserFlags

void unsetUserFlags()

Internal Use Only.

getE65Cuid

java.lang.String getE65Cuid()

Internal Use Only.

xgetE65Cuid

org.apache.xmlbeans.XmlString xgetE65Cuid()

Internal Use Only.

isSetE65Cuid

boolean isSetE65Cuid()

Internal Use Only.

setE65Cuid

void setE65Cuid(java.lang.String e65Cuid)

Internal Use Only.

xsetE65Cuid

void xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid)

Internal Use Only.

unsetE65Cuid

void unsetE65Cuid()

Internal Use Only.

getAttributeImportingEnabled

boolean getAttributeImportingEnabled()

Gets the AttributeImportingEnabled element

Returns:

true if the importing attributes is enabled, false otherwise.

xgetAttributeImportingEnabled

org.apache.xmlbeans.XmlBoolean xgetAttributeImportingEnabled()

Internal Use Only.

isSetAttributeImportingEnabled

boolean isSetAttributeImportingEnabled()

Checks if the AttributeImportingEnabled element has been set.

Returns:

true if the AttributeImportingEnabled element has been set, otherwise false.

setAttributeImportingEnabled

void setAttributeImportingEnabled(boolean attributeImportingEnabled)

Sets the AttributeImportingEnabled element.

Parameters:

attributeImportingEnabled -

xsetAttributeImportingEnabled

void xsetAttributeImportingEnabled(org.apache.xmlbeans.XmlBoolean attributeImportingEnabled)

Internal Use Only.

unsetAttributeImportingEnabled

void unsetAttributeImportingEnabled()

Deletes or unsets the AttributeImportingEnabled element

getUserProfiles

UserProfiles getUserProfiles()

Returns a collection of profile values for this user.

Returns:

A collection of profile values for this user.

isSetUserProfiles

boolean isSetUserProfiles()

Checks if the collection of profile values for this user has been set.

Returns:

true if the UserProfiles element has been set,otherwise false.

setUserProfiles

void setUserProfiles(UserProfiles userProfiles)

Sets a collection of profile values for this user.

Parameters:

userProfiles - A collection of profile values for this user.

addNewUserProfiles

UserProfiles addNewUserProfiles()

Appends and returns a new empty UserProfiles object as the last element of the array.

Returns:

A new UserProfiles object.

unsetUserProfiles

void unsetUserProfiles()

Deletes or unsets the UserProfiles element.

getSecondaryCredentials

SecondaryCredentials getSecondaryCredentials()

Returns the specified secondary credential.

Returns:

The secondary credentials.

isSetSecondaryCredentials

boolean isSetSecondaryCredentials()

Checks if the secondary credential has been set.

Returns:

true if the SecondaryCredentials element has been set,otherwise false.

setSecondaryCredentials

void setSecondaryCredentials(SecondaryCredentials secondaryCredentials)

Set the new value to the specified secondary credential or create a new one if the credential specified does not exist.

Parameters:

secondaryCredentials - The secondary credentials.

addNewSecondaryCredentials

SecondaryCredentials addNewSecondaryCredentials()

Appends and returns a new empty SecondaryCredentials object as the last element of the array.

Returns:

A new SecondaryCredentials object.

unsetSecondaryCredentials

void unsetSecondaryCredentials()

Deletes or unsets the SecondaryCredentials element.

getInbox

com.businessobjects.enterprise.user.User.Inbox getInbox()

Gets the Inbox element

Returns:

The Inbox object.

isSetInbox

boolean isSetInbox()

Checks if the Inbox element has been set.

Returns:

true if the Inbox element has been set else returns false.

setInbox

void setInbox(com.businessobjects.enterprise.user.User.Inbox inbox)

Sets the Inbox element.

Parameters:

inbox - The new Inbox object.

addNewInbox

com.businessobjects.enterprise.user.User.Inbox addNewInbox()

Appends and returns a new empty Inbox element.

Returns:

A new empty Inbox element.

unsetInbox

void unsetInbox()

Deletes or unsets the Inbox element

getFavoritesFolder

com.businessobjects.enterprise.user.User.FavoritesFolder getFavoritesFolder()

Gets the FavoritesFolder element.

Returns:

The FavoritesFolder element.

isSetFavoritesFolder

boolean isSetFavoritesFolder()

Checks if the FavoritesFolder element has been set

Returns:

true if the FavoritesFolder has been set, otherwise false.

setFavoritesFolder

void setFavoritesFolder(com.businessobjects.enterprise.user.User.FavoritesFolder favoritesFolder)

Sets the FavoritesFolder element.

addNewFavoritesFolder

com.businessobjects.enterprise.user.User.FavoritesFolder addNewFavoritesFolder()

Appends and returns a new empty FavoritesFolder element.

Returns:

A new empty FavoritesFolder element.

unsetFavoritesFolder

void unsetFavoritesFolder()

Deletes or unsets the FavoritesFolder element

getPersonalCategory

com.businessobjects.enterprise.user.User.PersonalCategory getPersonalCategory()

Gets the PersonalCategory element.

Returns:

The PersonalCategory element.

isSetPersonalCategory

boolean isSetPersonalCategory()

Checks if the PersonalCategory element has been set

Returns:

true if the PersonalCategory element has been set, otherwise false.

setPersonalCategory

void setPersonalCategory(com.businessobjects.enterprise.user.User.PersonalCategory personalCategory)

Sets the PersonalCategory element.

Parameters:

personalCategory -

addNewPersonalCategory

com.businessobjects.enterprise.user.User.PersonalCategory addNewPersonalCategory()

Appends and returns a new empty PersonalCategory element.

Returns:

A new empty PersonalCategory element.

unsetPersonalCategory

void unsetPersonalCategory()

Deletes or unsets the PersonalCategory element

getCustomProperties

CustomProperties getCustomProperties()

Returns the custom properties.

Returns:

The custom properties.

isSetCustomProperties

boolean isSetCustomProperties()

Checks if the custom properties have been set.

Returns:

true if the custom properties element has been set, otherwise false

setCustomProperties

void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:

customProperties - The custom properties.

addNewCustomProperties

CustomProperties addNewCustomProperties()

Appends and returns a new empty CustomProperties object as the last element of the array.

Returns:

A new CustomProperties object.

unsetCustomProperties

void unsetCustomProperties()

Deletes or unsets the CustomProperties element.