public interface IUserMaint extends IUser, IPrincipalMaint
IUser
and provides write access to a
user.
It provides methods to change the user's attributes, to commit these changes
to the user store or to roll them back (i.e. discard them) if appropriate. It
is intended for administration of user profiles (including
self-administration). It does not cover account, password and authorization
management. The set-methods with boolean return values return
true
if the new value is different from the previous value.
Calling set-methods with a value of null
effectively removes an
attribute.DEFAULT_ACCESSIBILITY_LEVEL, SCREENREADER_ACCESSIBILITY_LEVEL
BYTE_TYPE, CREATED_BY, DATASOURCE, DEFAULT_NAMESPACE, DEFAULT_RELATION_NAMESPACE, DESCRIPTION, DISPLAYNAME, LAST_MODIFIED_BY, PRINCIPAL_CREATION_DATE, PRINCIPAL_MODIFY_DATE, PRINCIPAL_RELATION_MEMBER_ATTRIBUTE, PRINCIPAL_RELATION_PARENT_ATTRIBUTE, STRING_TYPE, TRANSIENT_NAMESPACE, UNIQUE_NAME
Modifier and Type | Method and Description |
---|---|
void |
addToGroup(String uniqueIdOfGroup)
Deprecated.
use
IGroupFactory.addUserToGroup(String,String)
instead |
void |
addToRole(String uniqueIdOfRole)
Deprecated.
use
IRoleFactory.addUserToRole(String, String)
instead |
void |
removeFromGroup(String uniqueIdOfGroup)
Deprecated.
|
void |
removeFromRole(String uniqueIdOfRole)
Deprecated.
use
IRoleFactory.removeUserFromRole(String, String)
instead |
void |
setAccessibilityLevel(int accessibilityLevel)
Set the user's accessibility level used for Screen Reader Support
|
boolean |
setCellPhone(String cellphone)
Sets the user's default cell phone number.
|
boolean |
setCity(String city)
Sets the user's city.
|
boolean |
setCompany(String companyid)
Sets the unique ID of the user's company.
|
boolean |
setCountry(String country)
Sets the ISO-3166 two-letter uppercase code of the country where the user
lives.
|
boolean |
setCurrency(String currency)
Sets the three letter upper case code of the user's currency, e.g.
|
boolean |
setDepartment(String department)
Sets the user's department.
|
boolean |
setDisplayName(String displayName)
Sets the user's display name.
|
boolean |
setEmail(String email)
Sets the user's default email address.
|
boolean |
setFax(String fax)
Sets the user's default fax number.
|
boolean |
setFirstName(String firstname)
Sets the user's first name.
|
boolean |
setJobTitle(String jobtitle)
Sets the user's job title, e.g.
|
boolean |
setLastName(String lastname)
Sets the user's last name.
|
boolean |
setLocale(Locale locale)
Sets the user's Locale; this determines e.g. the language in which text
is displayed to the user's and the style that numbers are formated.
|
boolean |
setPersonID(String personid)
Sets the user's personID.
|
boolean |
setPhoto(byte[] photo)
Sets the user's photo as byte array.
|
boolean |
setSalutation(String salutation)
Sets the user's salutation.
|
boolean |
setState(String state)
Sets the user's state or region.
|
boolean |
setStreet(String street)
Sets the user's street.
|
boolean |
setTelephone(String telephone)
Sets the user's default telephone number.
|
boolean |
setTimeZone(TimeZone timezone)
Sets the user's time zone.
|
boolean |
setTitle(String title)
Sets the user's academic title or title of nobility.
|
boolean |
setZip(String zip)
Sets the zip code of the user's city.
|
checkPermission, checkPermission, getAccessibilityLevel, getCellPhone, getCity, getCompany, getCountry, getCurrency, getDepartment, getEmail, getFax, getFirstName, getI18nFormatterFactory, getJobTitle, getLastName, getLocale, getParentGroups, getPersonID, getPhoto, getRoles, getSalutation, getState, getStreet, getTelephone, getTimeZone, getTitle, getTransientAttribute, getUid, getUniqueName, getUserAccounts, getUserAccountUniqueIDs, getUserFactory, getZip, hasPermission, hasPermission, isCompanyUser, isMemberOfGroup, isMemberOfRole, setTransientAttribute
equals, getName, hashCode, implies, toString
addAttributeValue, commit, isModified, removeAttributeValue, rollback, save, setAttribute, setBinaryAttribute
created, equals, getAttribute, getAttributeNames, getAttributeNamespaces, getAttributeType, getBinaryAttribute, getDisplayName, getMessages, getParents, getUniqueID, hashCode, isExistenceChecked, isMutable, lastModified, refresh
boolean setTitle(String title)
title
- String containing the user's titletrue
if operation performed successfully.boolean setSalutation(String salutation)
salutation
- String containing the user's salutationtrue
if operation performed successfully.boolean setJobTitle(String jobtitle)
jobtitle
- String containing the user's job titletrue
if operation performed successfully.boolean setDepartment(String department)
department
- String containing the user's departmenttrue
if operation performed successfully.boolean setDisplayName(String displayName)
setDisplayName
in interface IPrincipalMaint
displayName
- String containing the user's displayNametrue
if operation performed successfully.boolean setFirstName(String firstname)
firstname
- String containing the user's first nametrue
if operation performed successfully.boolean setLastName(String lastname)
lastname
- String containing the user's last nametrue
if operation performed successfully.boolean setStreet(String street)
street
- String containing the user's streettrue
if operation performed successfully.boolean setCity(String city)
city
- String containing the user's citytrue
if operation performed successfully.boolean setZip(String zip)
zip
- String containing the user's ziptrue
if operation performed successfully.boolean setState(String state)
state
- String containing the user's statetrue
if operation performed successfully.boolean setCountry(String country)
Note: that this is independent from the country available via
getCountry()
of the user's Locale, since expatriate users
may not have their Locale's country set to the country where they
actually reside.
country
- String containing the user's countrytrue
if operation performed successfully.boolean setLocale(Locale locale)
locale
- String containing the user's locale objecttrue
if operation performed successfully.boolean setTimeZone(TimeZone timezone)
timezone
- String containing the user's timezonetrue
if operation performed successfully.boolean setCurrency(String currency)
currency
- String containing the user's currencytrue
if operation performed successfully.boolean setTelephone(String telephone)
telephone
- String containing the user's telephonetrue
if operation performed successfully.boolean setCellPhone(String cellphone)
cellphone
- String containing the user's cellphonetrue
if operation performed successfully.boolean setFax(String fax)
fax
- String containing the user's faxtrue
if operation performed successfully.boolean setEmail(String email)
email
- String containing the user's emailtrue
if operation performed successfully.boolean setPersonID(String personid)
personid
- The new personID to set.true
if operation performed successfully.boolean setCompany(String companyid)
companyid
- String containing the user's company idtrue
if operation performed successfully.void setAccessibilityLevel(int accessibilityLevel) throws UMException
accessibilityLevel
- String containing the user's accessibility
level Valid values are following constants
IUser.DEFAULT_ACCESSIBILITY_LEVEL
or
IUser.SCREENREADER_ACCESSIBILITY_LEVEL
UMException
- if an error occurred.void addToGroup(String uniqueIdOfGroup) throws UMException
IGroupFactory.addUserToGroup(String,String)
insteaduniqueIdOfGroup
- id of the groupUMException
- if user cannot be added to groupvoid removeFromGroup(String uniqueIdOfGroup) throws UMException
IGroupFactory.removeUserFromGroup(String, String)
insteaduniqueIdOfGroup
- id of the groupUMException
- if user cannot be removed from groupvoid addToRole(String uniqueIdOfRole) throws UMException
IRoleFactory.addUserToRole(String, String)
insteaduniqueIdOfRole
- uniqueId of a roleUMException
- if an error occurred.void removeFromRole(String uniqueIdOfRole) throws UMException
IRoleFactory.removeUserFromRole(String, String)
insteaduniqueIdOfRole
- uniqueId of a roleUMException
- if an error occurred.boolean setPhoto(byte[] photo)
Note: If the byte array is too big performance issues are possible
photo
- - the image as a byte array. Calling the method with a value of null
effectively removes the attribute.true
if operation performed successfully.Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] CORE-TOOLS
|
[sap.com]
|
default
|
BC-JAS
|
[sap.com] ENGFACADE
|
[sap.com] tc/je/usermanagement/api
|
api
|
BC-JAS-SEC
|
[sap.com] ENGINEAPI
|
[sap.com]
|
-
|
BC-JAS-SEC-UME
|
[sap.com] ENGINEAPI
|
[sap.com]
|
default
|
BC-JAS-SEC-UME
|
Copyright 2018 SAP AG Complete Copyright Notice