UpdateUser.Builder (scim-schema 1.1 API)

java.lang.Object
- org.osiam.resources.scim.UpdateUser.Builder

Enclosing class:

UpdateUser
```
public static class UpdateUser.Builder
extends Object
```
The Builder is used to construct instances of the UpdateUser

Constructor Summary

Constructors
Constructor and Description

UpdateUser.Builder()

Constructors
Constructor and Description
`UpdateUser.Builder()`

Method Summary

Methods
Modifier and Type	Method and Description
`UpdateUser.Builder`	`addAddress(Address address)` adds a new address to the existing addresses of a existing user
`UpdateUser.Builder`	`addEmail(Email email)` adds or updates a emil of an existing user if the .getValue() already exists a update will be done.
`UpdateUser.Builder`	`addEntitlement(Entitlement entitlement)` adds or updates a entitlement to an existing user if the .getValue() already exists a update will be done.
`UpdateUser.Builder`	`addIm(Im im)` adds or updates a ims to an existing user if the .getValue() already exists a update will be done.
`UpdateUser.Builder`	`addPhoneNumber(PhoneNumber phoneNumber)` adds or updates a phoneNumber to an existing user if the .getValue() already exists a update will be done.
`UpdateUser.Builder`	`addPhoto(Photo photo)` adds or updates a photo to an existing user if the .getValue() already exists a update will be done.
`UpdateUser.Builder`	`addRole(Role role)` adds or updates a role of an existing user if the .getValue() already exists a update will be done.
`UpdateUser.Builder`	`addX509Certificate(X509Certificate certificate)` adds or updates certificate to an existing user if the .getValue() already exists a update will be done.
`UpdateUser`	`build()` constructs a UpdateUser with the given values
`UpdateUser.Builder`	`deleteAddress(Address address)` deletes the given address from the list of existing addresses of a existing user
`UpdateUser.Builder`	`deleteAddresses()` deletes all existing addresses of the a existing user
`UpdateUser.Builder`	`deleteDisplayName()` deletes the display name of a existing user
`UpdateUser.Builder`	`deleteEmail(Email email)` deletes the given email of a existing user
`UpdateUser.Builder`	`deleteEmails()` deletes all emails of a existing user
`UpdateUser.Builder`	`deleteEntitlement(Entitlement entitlement)` deletes the entitlement of a existing user
`UpdateUser.Builder`	`deleteEntitlements()` deletes all entitlements of a existing user
`UpdateUser.Builder`	`deleteExtension(String urn)` deletes the given extension of a existing user
`UpdateUser.Builder`	`deleteExtensionField(String urn, String fieldName)` deletes the given extension field of a existing user
`UpdateUser.Builder`	`deleteExternalId()` delete the external Id of a existing user
`UpdateUser.Builder`	`deleteIm(Im im)` deletes the ims of a existing user
`UpdateUser.Builder`	`deleteIms()` deletes all ims of a existing user
`UpdateUser.Builder`	`deleteLocal()` delete the local value of a existing user
`UpdateUser.Builder`	`deleteName()` deletes the name of a existing user
`UpdateUser.Builder`	`deleteNickName()` deletes the nickName of a existing user
`UpdateUser.Builder`	`deletePhoneNumber(PhoneNumber phoneNumber)` deletes the phonenumber of a existing user
`UpdateUser.Builder`	`deletePhoneNumbers()` deletes all phonenumbers of a existing user
`UpdateUser.Builder`	`deletePhoto(Photo photo)` deletes the photo of a existing user
`UpdateUser.Builder`	`deletePhotos()` deletes all photos of a existing user
`UpdateUser.Builder`	`deletePreferredLanguage()` delete the preferred Language of a existing user
`UpdateUser.Builder`	`deleteProfileUrl()` deletes the profil Url of a existing user
`UpdateUser.Builder`	`deleteRole(Role role)` deletes the given role of a existing user
`UpdateUser.Builder`	`deleteRole(String role)` deletes the given role of a existing user
`UpdateUser.Builder`	`deleteRoles()` deletes all roles of a existing user
`UpdateUser.Builder`	`deleteTimezone()` deletes the timezone of a existing user
`UpdateUser.Builder`	`deleteTitle()` deletes the title of a existing user
`UpdateUser.Builder`	`deleteUserType()` deletes the user type of a existing user
`UpdateUser.Builder`	`deleteX509Certificate(X509Certificate certificate)` deletes the given certificate of a existing user
`UpdateUser.Builder`	`deleteX509Certificates()` deletes all X509Certificates of a existing user
`UpdateUser.Builder`	`updateActive(boolean active)` updates the active status of a existing User to the given value
`UpdateUser.Builder`	`updateAddress(Address oldAddress, Address newAddress)` updates the old Address with the new one
`UpdateUser.Builder`	`updateDisplayName(String displayName)` updates the display name of a existing user
`UpdateUser.Builder`	`updateEmail(Email oldEmail, Email newEmail)` updates the old Email with the new one
`UpdateUser.Builder`	`updateEntitlement(Entitlement oldEntitlement, Entitlement newEntitlement)` updates the old Entitlement with the new one
`UpdateUser.Builder`	`updateExtension(Extension extension)` updates the given fields in the extension.
`UpdateUser.Builder`	`updateExternalId(String externalId)` updates the external id of a existing user
`UpdateUser.Builder`	`updateIm(Im oldIm, Im newIm)` updates the old Ims with the new one
`UpdateUser.Builder`	`updateLocale(String locale)` updates the local of a existing user
`UpdateUser.Builder`	`updateName(Name name)` updates the name of a existing user
`UpdateUser.Builder`	`updateNickName(String nickName)` updates the nickName of a existing user
`UpdateUser.Builder`	`updatePassword(String password)` updates the password of a existing user
`UpdateUser.Builder`	`updatePhoneNumber(PhoneNumber oldPhoneNumber, PhoneNumber newPhoneNumber)` updates the old PhoneNumber with the new one
`UpdateUser.Builder`	`updatePhoto(Photo oldPhoto, Photo newPhoto)` updates the old Photo with the new one
`UpdateUser.Builder`	`updatePreferredLanguage(String preferredLanguage)` updates the preferred language of a existing user
`UpdateUser.Builder`	`updateProfileUrl(String profileUrl)` updates the profil URL of a existing user
`UpdateUser.Builder`	`updateRole(Role oldRole, Role newRole)` updates the old Role with the new one
`UpdateUser.Builder`	`updateTimezone(String timezone)` updates the timezone of a existing user
`UpdateUser.Builder`	`updateTitle(String title)` updates the title of a existing user
`UpdateUser.Builder`	`updateUserName(String userName)` updates the nickName of a existing user
`UpdateUser.Builder`	`updateUserType(String userType)` updates the user type of a existing user
`UpdateUser.Builder`	`updateX509Certificate(X509Certificate oldCertificate, X509Certificate newCertificate)` updates the old X509Certificate with the new one

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

- Constructor Detail
  - UpdateUser.Builder
```
public UpdateUser.Builder()
```
- Method Detail
  - updateUserName
```
public UpdateUser.Builder updateUserName(String userName)
```
    updates the nickName of a existing user
    
    Parameters:
    userName - the new user name
    
    Returns:
    The builder itself
  - addAddress
```
public UpdateUser.Builder addAddress(Address address)
```
    adds a new address to the existing addresses of a existing user
    
    Parameters:
    address - the new address
    
    Returns:
    The builder itself
  - deleteAddress
```
public UpdateUser.Builder deleteAddress(Address address)
```
    deletes the given address from the list of existing addresses of a existing user
    
    Parameters:
    address - address to be deleted
    
    Returns:
    The builder itself
  - deleteAddresses
```
public UpdateUser.Builder deleteAddresses()
```
    deletes all existing addresses of the a existing user
    
    Returns:
    The builder itself
  - updateAddress
```
public UpdateUser.Builder updateAddress(Address oldAddress,
                               Address newAddress)
```
    updates the old Address with the new one
    
    Parameters:
    oldAddress - to be replaced
    newAddress - new Address
    
    Returns:
    The builder itself
  - deleteNickName
```
public UpdateUser.Builder deleteNickName()
```
    deletes the nickName of a existing user
    
    Returns:
    The builder itself
  - updateNickName
```
public UpdateUser.Builder updateNickName(String nickName)
```
    updates the nickName of a existing user
    
    Parameters:
    nickName - the new nickName
    
    Returns:
    The builder itself
  - deleteExternalId
```
public UpdateUser.Builder deleteExternalId()
```
    delete the external Id of a existing user
    
    Returns:
    The builder itself
  - updateExternalId
```
public UpdateUser.Builder updateExternalId(String externalId)
```
    updates the external id of a existing user
    
    Parameters:
    externalId - new external id
    
    Returns:
    The builder itself
  - deleteLocal
```
public UpdateUser.Builder deleteLocal()
```
    delete the local value of a existing user
    
    Returns:
    The builder itself
  - updateLocale
```
public UpdateUser.Builder updateLocale(String locale)
```
    updates the local of a existing user
    
    Parameters:
    locale - new local
    
    Returns:
    The builder itself
  - updatePassword
```
public UpdateUser.Builder updatePassword(String password)
```
    updates the password of a existing user
    
    Parameters:
    password - new password
    
    Returns:
    The builder itself
  - deletePreferredLanguage
```
public UpdateUser.Builder deletePreferredLanguage()
```
    delete the preferred Language of a existing user
    
    Returns:
    The builder itself
  - updatePreferredLanguage
```
public UpdateUser.Builder updatePreferredLanguage(String preferredLanguage)
```
    updates the preferred language of a existing user
    
    Parameters:
    preferredLanguage - new preferred language
    
    Returns:
    The builder itself
  - deleteProfileUrl
```
public UpdateUser.Builder deleteProfileUrl()
```
    deletes the profil Url of a existing user
    
    Returns:
    The builder itself
  - updateProfileUrl
```
public UpdateUser.Builder updateProfileUrl(String profileUrl)
```
    updates the profil URL of a existing user
    
    Parameters:
    profileUrl - new profilUrl
    
    Returns:
    The builder itself
  - deleteTimezone
```
public UpdateUser.Builder deleteTimezone()
```
    deletes the timezone of a existing user
    
    Returns:
    The builder itself
  - updateTimezone
```
public UpdateUser.Builder updateTimezone(String timezone)
```
    updates the timezone of a existing user
    
    Parameters:
    timezone - new timeZone
    
    Returns:
    The builder itself
  - deleteTitle
```
public UpdateUser.Builder deleteTitle()
```
    deletes the title of a existing user
    
    Returns:
    The builder itself
  - updateTitle
```
public UpdateUser.Builder updateTitle(String title)
```
    updates the title of a existing user
    
    Parameters:
    title - new tile
    
    Returns:
    The builder itself
  - deleteName
```
public UpdateUser.Builder deleteName()
```
    deletes the name of a existing user
    
    Returns:
    The builder itself
  - updateName
```
public UpdateUser.Builder updateName(Name name)
```
    updates the name of a existing user
    
    Parameters:
    name - new Name
    
    Returns:
    The builder itself
  - deleteUserType
```
public UpdateUser.Builder deleteUserType()
```
    deletes the user type of a existing user
    
    Returns:
    The builder itself
  - updateUserType
```
public UpdateUser.Builder updateUserType(String userType)
```
    updates the user type of a existing user
    
    Parameters:
    userType - new user type
    
    Returns:
    The builder itself
  - deleteDisplayName
```
public UpdateUser.Builder deleteDisplayName()
```
    deletes the display name of a existing user
    
    Returns:
    The builder itself
  - updateDisplayName
```
public UpdateUser.Builder updateDisplayName(String displayName)
```
    updates the display name of a existing user
    
    Parameters:
    displayName - new display name
    
    Returns:
    The builder itself
  - deleteEmails
```
public UpdateUser.Builder deleteEmails()
```
    deletes all emails of a existing user
    
    Returns:
    The builder itself
  - deleteEmail
```
public UpdateUser.Builder deleteEmail(Email email)
```
    deletes the given email of a existing user
    
    Parameters:
    email - to be deleted
    
    Returns:
    The builder itself
  - addEmail
```
public UpdateUser.Builder addEmail(Email email)
```
    adds or updates a emil of an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    email - new email
    
    Returns:
    The builder itself
  - updateEmail
```
public UpdateUser.Builder updateEmail(Email oldEmail,
                             Email newEmail)
```
    updates the old Email with the new one
    
    Parameters:
    oldEmail - to be replaced
    newEmail - new Email
    
    Returns:
    The builder itself
  - deleteX509Certificates
```
public UpdateUser.Builder deleteX509Certificates()
```
    deletes all X509Certificates of a existing user
    
    Returns:
    The builder itself
  - deleteX509Certificate
```
public UpdateUser.Builder deleteX509Certificate(X509Certificate certificate)
```
    deletes the given certificate of a existing user
    
    Parameters:
    certificate - to be deleted
    
    Returns:
    The builder itself
  - addX509Certificate
```
public UpdateUser.Builder addX509Certificate(X509Certificate certificate)
```
    adds or updates certificate to an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    certificate - new certificate
    
    Returns:
    The builder itself
  - updateX509Certificate
```
public UpdateUser.Builder updateX509Certificate(X509Certificate oldCertificate,
                                       X509Certificate newCertificate)
```
    updates the old X509Certificate with the new one
    
    Parameters:
    oldCertificate - to be replaced
    newCertificate - new X509Certificate
    
    Returns:
    The builder itself
  - deleteRoles
```
public UpdateUser.Builder deleteRoles()
```
    deletes all roles of a existing user
    
    Returns:
    The builder itself
  - deleteRole
```
public UpdateUser.Builder deleteRole(Role role)
```
    deletes the given role of a existing user
    
    Parameters:
    role - to be deleted
    
    Returns:
    The builder itself
  - deleteRole
```
public UpdateUser.Builder deleteRole(String role)
```
    deletes the given role of a existing user
    
    Parameters:
    role - to be deleted
    
    Returns:
    The builder itself
  - addRole
```
public UpdateUser.Builder addRole(Role role)
```
    adds or updates a role of an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    role - new role
    
    Returns:
    The builder itself
  - updateRole
```
public UpdateUser.Builder updateRole(Role oldRole,
                            Role newRole)
```
    updates the old Role with the new one
    
    Parameters:
    oldRole - to be replaced
    newRole - new Role
    
    Returns:
    The builder itself
  - deleteIms
```
public UpdateUser.Builder deleteIms()
```
    deletes all ims of a existing user
    
    Returns:
    The builder itself
  - deleteIm
```
public UpdateUser.Builder deleteIm(Im im)
```
    deletes the ims of a existing user
    
    Parameters:
    im - to be deleted
    
    Returns:
    The builder itself
  - addIm
```
public UpdateUser.Builder addIm(Im im)
```
    adds or updates a ims to an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    im - new ims
    
    Returns:
    The builder itself
  - updateIm
```
public UpdateUser.Builder updateIm(Im oldIm,
                          Im newIm)
```
    updates the old Ims with the new one
    
    Parameters:
    oldIm - to be replaced
    newIm - new Ims
    
    Returns:
    The builder itself
  - addPhoneNumber
```
public UpdateUser.Builder addPhoneNumber(PhoneNumber phoneNumber)
```
    adds or updates a phoneNumber to an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    phoneNumber - new phoneNumber
    
    Returns:
    The builder itself
  - deletePhoneNumber
```
public UpdateUser.Builder deletePhoneNumber(PhoneNumber phoneNumber)
```
    deletes the phonenumber of a existing user
    
    Parameters:
    phoneNumber - to be deleted
    
    Returns:
    The builder itself
  - deletePhoneNumbers
```
public UpdateUser.Builder deletePhoneNumbers()
```
    deletes all phonenumbers of a existing user
    
    Returns:
    The builder itself
  - updatePhoneNumber
```
public UpdateUser.Builder updatePhoneNumber(PhoneNumber oldPhoneNumber,
                                   PhoneNumber newPhoneNumber)
```
    updates the old PhoneNumber with the new one
    
    Parameters:
    oldPhoneNumber - to be replaced
    newPhoneNumber - new PhoneNumber
    
    Returns:
    The builder itself
  - addPhoto
```
public UpdateUser.Builder addPhoto(Photo photo)
```
    adds or updates a photo to an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    photo - new photo
    
    Returns:
    The builder itself
  - deletePhoto
```
public UpdateUser.Builder deletePhoto(Photo photo)
```
    deletes the photo of a existing user
    
    Parameters:
    photo - to be deleted
    
    Returns:
    The builder itself
  - deletePhotos
```
public UpdateUser.Builder deletePhotos()
```
    deletes all photos of a existing user
    
    Returns:
    The builder itself
  - updatePhoto
```
public UpdateUser.Builder updatePhoto(Photo oldPhoto,
                             Photo newPhoto)
```
    updates the old Photo with the new one
    
    Parameters:
    oldPhoto - to be replaced
    newPhoto - new Photo
    
    Returns:
    The builder itself
  - deleteEntitlements
```
public UpdateUser.Builder deleteEntitlements()
```
    deletes all entitlements of a existing user
    
    Returns:
    The builder itself
  - deleteEntitlement
```
public UpdateUser.Builder deleteEntitlement(Entitlement entitlement)
```
    deletes the entitlement of a existing user
    
    Parameters:
    entitlement - to be deleted
    
    Returns:
    The builder itself
  - addEntitlement
```
public UpdateUser.Builder addEntitlement(Entitlement entitlement)
```
    adds or updates a entitlement to an existing user if the .getValue() already exists a update will be done. If not a new one will be added
    
    Parameters:
    entitlement - new entitlement
    
    Returns:
    The builder itself
  - updateEntitlement
```
public UpdateUser.Builder updateEntitlement(Entitlement oldEntitlement,
                                   Entitlement newEntitlement)
```
    updates the old Entitlement with the new one
    
    Parameters:
    oldEntitlement - to be replaced
    newEntitlement - new Entitlement
    
    Returns:
    The builder itself
  - updateActive
```
public UpdateUser.Builder updateActive(boolean active)
```
    updates the active status of a existing User to the given value
    
    Parameters:
    active - new active status
    
    Returns:
    The builder itself
  - deleteExtension
```
public UpdateUser.Builder deleteExtension(String urn)
```
    deletes the given extension of a existing user
    
    Parameters:
    urn - the id of the extension to be deleted
    
    Returns:
    The builder itself
  - deleteExtensionField
```
public UpdateUser.Builder deleteExtensionField(String urn,
                                      String fieldName)
```
    deletes the given extension field of a existing user
    
    Parameters:
    urn - the id of the extension to be deleted
    fieldName - the fieldName of a the extension to be deleted
    
    Returns:
    The builder itself
  - updateExtension
```
public UpdateUser.Builder updateExtension(Extension extension)
```
    updates the given fields in the extension. If the User doesn't have the given extension fields, they will be added.
    
    Parameters:
    extension - extension with all fields that need to be updated or added
    
    Returns:
    The builder itself
  - build
```
public UpdateUser build()
```
    constructs a UpdateUser with the given values
    
    Returns:
    a valid UpdateUser

Class UpdateUser.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateUser.Builder

Method Detail

updateUserName

addAddress

deleteAddress

deleteAddresses

updateAddress

deleteNickName

updateNickName

deleteExternalId

updateExternalId

deleteLocal

updateLocale

updatePassword

deletePreferredLanguage

updatePreferredLanguage

deleteProfileUrl

updateProfileUrl

deleteTimezone

updateTimezone

deleteTitle

updateTitle

deleteName

updateName

deleteUserType

updateUserType

deleteDisplayName

updateDisplayName

deleteEmails

deleteEmail

addEmail

updateEmail

deleteX509Certificates

deleteX509Certificate

addX509Certificate

updateX509Certificate

deleteRoles

deleteRole

deleteRole

addRole

updateRole

deleteIms

deleteIm

addIm

updateIm

addPhoneNumber

deletePhoneNumber

deletePhoneNumbers

updatePhoneNumber

addPhoto

deletePhoto

deletePhotos

updatePhoto

deleteEntitlements

deleteEntitlement

addEntitlement

updateEntitlement

updateActive

deleteExtension

deleteExtensionField

updateExtension

build