Package com.novomind.ecom.api.imail.routing.persistence

Interface UserModifier

All Superinterfaces:
IntermediateStorageProvider, Modifier<User>, UndeletableModifier<User>
public interface UserModifier extends UndeletableModifier<User>, IntermediateStorageProvider
Since:
11.2

  • Method Details

    • getName

      String getName()
      Get the current user name which is held in this UserModifier.
      Returns:
      the name as String
      Since:
      11.2

    • setName

      UserModifier setName(String name) throws ValidationException

      Change the name of the associated User.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      name - the new name as String
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the new name is invalid
      Since:
      11.2

    • validateName

      boolean validateName(String name) throws ValidationException
      Validate the given name.
      Parameters:
      name - the name to validate as String
      Returns:
      true if the name is valid
      Throws:
      ValidationException - if the name is invalid
      Since:
      11.2

    • getUsername

      String getUsername()
      Get the current user username which is held in this UserModifier.
      Returns:
      the username as String
      Since:
      11.2

    • setUsername

      UserModifier setUsername(String username) throws ValidationException

      Change the username of the associated User. The username needs to be unique in the novomind iAGENT system. Please note that the username can only be changed if the User is not logged in.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      username - the new username as String
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the new username is invalid or the user is logged in
      Since:
      11.2

    • validateUsername

      boolean validateUsername(String username) throws ValidationException
      Validate the given username. The username needs to be unique in the novomind iAGENT system. Please note that the username can only be changed if the User is not logged in.
      Parameters:
      username - the username to validate as String
      Returns:
      true if the username is valid
      Throws:
      ValidationException - if the username is invalid or the user is logged in
      Since:
      11.2

    • getPassword

      String getPassword()
      Get the current user password which is held in this UserModifier. There is no fallback to the underlaying user. If the password hasn't been changed in this UserModifier this method returns null.
      Returns:
      the password as String
      Since:
      11.2

    • setPassword

      UserModifier setPassword(String password) throws ValidationException

      Change the password of the associated User.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      password - the new password as String
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the new password is invalid
      Since:
      11.2

    • validatePassword

      boolean validatePassword(String password) throws ValidationException
      Validate the given password.
      Parameters:
      password - the password to validate as String
      Returns:
      true if the password is valid
      Throws:
      ValidationException - if the password is invalid
      Since:
      11.2

    • getEmailAddress

      String getEmailAddress()
      Get the current user email address in the form local-part@domain (see https://tools.ietf.org/html/rfc5322#section-3.4.1) which is held in this UserModifier.
      Returns:
      the email address as String in the form local-part@domain (see https://tools.ietf.org/html/rfc5322#section-3.4.1)
      Since:
      11.2

    • setEmailAddress

      UserModifier setEmailAddress(String emailAddress) throws ValidationException

      Change the email address of the associated User. The email address needs to be unique in the novomind iAGENT system. Please note that the email address can only be changed if the User is not logged in.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      emailAddress - the new email address as String in the form local-part@domain (see https://tools.ietf.org/html/rfc5322#section-3.4.1)
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the new email address is invalid or the user is logged in
      Since:
      11.2

    • validateEmailAddress

      boolean validateEmailAddress(String emailAddress) throws ValidationException
      Validate the given email address. The email address needs to be unique in the novomind iAGENT system. Please note that the email address can only be changed if the User is not logged in.
      Parameters:
      emailAddress - the email address to validate as String in the form local-part@domain (see https://tools.ietf.org/html/rfc5322#section-3.4.1)
      Returns:
      true if the email address is valid
      Throws:
      ValidationException - if the email address is invalid or the user is logged in
      Since:
      11.2

    • isCallRoutingEnabled

      boolean isCallRoutingEnabled()
      Get the current call routing enabled value which is held in this UserModifier.
      Returns:
      true if the call routing is enabled for this user, otherwise false
      Since:
      13.0

    • setCallRoutingEnabled

      UserModifier setCallRoutingEnabled(boolean callRoutingEnabled) throws ValidationException

      Change the call routing enabled value.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      callRoutingEnabled - the new call routing enabled value
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      13.0

    • validateCallRoutingEnabled

      boolean validateCallRoutingEnabled(boolean callRoutingEnabled) throws ValidationException
      Validate the given call routing enabled value.
      Parameters:
      callRoutingEnabled - the new call routing enabled value
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      13.0

    • isClearanceRequired

      boolean isClearanceRequired()
      Get the current clearance required value which is held in this UserModifier.
      Returns:
      true if a clearance is required, otherwise false
      Since:
      12.2

    • setClearanceRequired

      UserModifier setClearanceRequired(boolean clearanceRequired) throws ValidationException

      Change the clearance required value.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      clearanceRequired - the new clearance required value
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • validateClearanceRequired

      boolean validateClearanceRequired(boolean clearanceRequired) throws ValidationException
      Validate the given clearance required value.
      Parameters:
      clearanceRequired - the new clearance required value
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • hasClearanceAuthority

      boolean hasClearanceAuthority()
      Get the current clearance authority value which is held in this UserModifier.
      Returns:
      true if the user has clearance authority, otherwise false
      Since:
      13.0

    • setClearanceAuthority

      UserModifier setClearanceAuthority(boolean clearanceAuthority) throws ValidationException

      Change the clearance authority value.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      clearanceAuthority - the new clearance authority value
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      13.0

    • validateClearanceAuthority

      boolean validateClearanceAuthority(boolean clearanceAuthority) throws ValidationException
      Validate the given clearance authority value.
      Parameters:
      clearanceAuthority - the new clearance authority value
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      13.0

    • getMaxMails

      int getMaxMails()
      Get the current maximum number of mails that should be routed to this user which is held in this UserModifier.
      Returns:
      the maximum number of mails that should be routed to this user
      Since:
      12.2

    • setMaxMails

      UserModifier setMaxMails(int maxMails) throws ValidationException

      Change the maximum number of mails that should be routed to this user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      maxMails - the new maximum number of mails that should be routed to this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • validateMaxMails

      boolean validateMaxMails(int maxMails) throws ValidationException
      Validate the given maximum number of mails that should be routed to this user.
      Parameters:
      maxMails - the new maximum number of mails that should be routed to this user
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • getMaxChats

      int getMaxChats()
      Get the current maximum number of chats that should be routed to this user which is held in this UserModifier.
      Returns:
      the maximum number of chats that should be routed to this user
      Since:
      12.2

    • setMaxChats

      UserModifier setMaxChats(int maxChats) throws ValidationException

      Change the maximum number of chats that should be routed to this user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      maxChats - the new maximum number of chats that should be routed to this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • validateMaxChats

      boolean validateMaxChats(int maxChats) throws ValidationException
      Validate the given maximum number of chats that should be routed to this user.
      Parameters:
      maxChats - the new maximum number of chats that should be routed to this user
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • getAutoRoutingCategoryMode

      User.CategoryMode getAutoRoutingCategoryMode()
      Get the current CategoryMode for the automatic routing of this user which is held in this UserModifier.
      Returns:
      the CategoryMode for the automatic routing
      Since:
      12.2

    • setAutoRoutingCategoryMode

      UserModifier setAutoRoutingCategoryMode(User.CategoryMode autoRoutingCategoryMode) throws ValidationException

      Change the CategoryMode for the automatic routing of this user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      autoRoutingCategoryMode - the new CategoryMode for the automatic routing of this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • validateAutoRoutingCategoryMode

      boolean validateAutoRoutingCategoryMode(User.CategoryMode autoRoutingCategoryMode) throws ValidationException
      Validate the CategoryMode for the automatic routing of this user.
      Parameters:
      autoRoutingCategoryMode - the new CategoryMode for the automatic routing of this user
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • getManualRoutingCategoryMode

      User.CategoryMode getManualRoutingCategoryMode()
      Get the current CategoryMode for the manual routing of this user which is held in this UserModifier.
      Returns:
      the CategoryMode for the manual routing
      Since:
      12.2

    • setManualRoutingCategoryMode

      UserModifier setManualRoutingCategoryMode(User.CategoryMode manualRoutingCategoryMode) throws ValidationException

      Change the CategoryMode for the manual routing of this user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      manualRoutingCategoryMode - the new CategoryMode for the manual routing of this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • validateManualRoutingCategoryMode

      boolean validateManualRoutingCategoryMode(User.CategoryMode manualRoutingCategoryMode) throws ValidationException
      Validate the CategoryMode for the manual routing of this user.
      Parameters:
      manualRoutingCategoryMode - the new CategoryMode for the manual routing of this user
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.2

    • getManualRoutingClearanceAuthorizationCategoryMode

      User.CategoryMode getManualRoutingClearanceAuthorizationCategoryMode()
      Get the current CategoryMode for the manual routing ability of clearance authorizations of this user which is held in this UserModifier.
      Returns:
      the CategoryMode for the manual routing ability of clearance authorizations of this user
      Since:
      13.0

    • setManualRoutingClearanceAuthorizationCategoryMode

      UserModifier setManualRoutingClearanceAuthorizationCategoryMode(User.CategoryMode manualRoutingClearanceAuthorizationCategoryMode) throws ValidationException

      Change the CategoryMode for the manual routing ability of clearance authorizations of this user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      manualRoutingClearanceAuthorizationCategoryMode - the new CategoryMode for the manual routing ability of clearance authorizations of this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      13.0

    • validateManualRoutingClearanceAuthorizationCategoryMode

      boolean validateManualRoutingClearanceAuthorizationCategoryMode(User.CategoryMode manualRoutingClearanceAuthorizationCategoryMode) throws ValidationException
      Validate the CategoryMode for the manual routing ability of clearance authorizations of this user.
      Parameters:
      manualRoutingClearanceAuthorizationCategoryMode - the new CategoryMode for the manual routing ability of clearance authorizations of this user
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid
      Since:
      13.0

    • getLocale

      Locale getLocale()
      Get the current Locale representing the display language of this user which is held in this UserModifier. Please note that only the language attribute of the given Locale is used.
      Returns:
      the display language as Locale
      Since:
      12.20

    • setLocale

      UserModifier setLocale(Locale locale) throws ValidationException

      Change the Locale representing the display language of this user. Please note that only the language attribute of the given Locale is used.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      locale - the new Locale representing the display language of this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.20

    • validateLocale

      boolean validateLocale(Locale locale) throws ValidationException
      Validate the Locale representing the display language of this user. Please note that only the language attribute of the given Locale is used.
      Parameters:
      locale - the new Locale representing the display language of this user
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid
      Since:
      12.20

    • isAgent

      boolean isAgent()
      Get the current agent flag which is held in this UserModifier.
      Returns:
      true if the user is an agent, otherwise false
      Since:
      12.20

    • setAgent

      UserModifier setAgent(boolean agent) throws ValidationException

      Change the agent flag. Please note that the agent flag can only be changed if the User is not logged in.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      agent - the new agent flag
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the change is invalid or the user is logged in
      Since:
      12.20

    • validateAgent

      boolean validateAgent(boolean agent) throws ValidationException
      Validate the given agent flag. Please note that the agent flag can only be changed if the User is not logged in.
      Parameters:
      agent - the new agent flag
      Returns:
      true if the change is valid
      Throws:
      ValidationException - if the change is invalid or the user is logged in
      Since:
      12.20

    • getLocation

      Location getLocation()
      Get the current Location which is held in this UserModifier.
      Returns:
      the location
      Since:
      12.27

    • setLocation

      UserModifier setLocation(Location location) throws ValidationException
      Set the location.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      location - the new location
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the location is invalid
      Since:
      12.27

    • validateLocation

      boolean validateLocation(Location location) throws ValidationException
      Validate the given location.
      Parameters:
      location - the new location
      Returns:
      true if the location is valid
      Throws:
      ValidationException - if the location is invalid
      Since:
      12.27

    • isLocked

      boolean isLocked()
      Get the current locked flag which is held in this UserModifier.
      Returns:
      true if the user is locked, otherwise false
      Since:
      12.27

    • setLocked

      UserModifier setLocked(boolean locked)

      Change the locked flag.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      locked - the new locked flag
      Returns:
      the UserModifier
      Since:
      12.27

    • getSignature

      String getSignature()
      Get the current signature which is held in this UserModifier.
      Returns:
      the signature as String
      Since:
      12.27

    • setSignature

      UserModifier setSignature(String signature) throws ValidationException

      Change the signature of the associated User.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      signature - the new signature as String
      Returns:
      the UserModifier
      Throws:
      ValidationException - if the new signature is invalid
      Since:
      12.27

    • validateSignature

      boolean validateSignature(String signature) throws ValidationException
      Validate the given signature.
      Parameters:
      signature - the signature to validate as String
      Returns:
      true if the signature is valid
      Throws:
      ValidationException - if the signature is invalid
      Since:
      12.27

    • getLanguageSkills

      Set<Locale> getLanguageSkills()
      Get the current language skills which are held in this UserModifier. Please note that only the language attribute of the given Locale is used.
      Returns:
      the language skills as a Set of Locale
      Since:
      12.27

    • addLanguageSkills

      UserModifier addLanguageSkills(Locale... languages) throws ValidationException

      Add the passed language skills to the user. Please note that only the language attribute of the given Locale is used.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      languages - the language skills that should be added
      Returns:
      the UserModifier
      Throws:
      ValidationException - if a language is null or not valid
      Since:
      12.27

    • removeLanguageSkills

      UserModifier removeLanguageSkills(Locale... languages) throws ValidationException

      Remove the passed language skills of the user. Please note that only the language attribute of the given Locale is used.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      languages - the language skills that should be removed
      Returns:
      the UserModifier
      Throws:
      ValidationException - if a language is null or not valid
      Since:
      12.27

    • getRoutingTags

      Set<RoutingTag> getRoutingTags()
      Get the current routing tags which are held in this UserModifier.
      Returns:
      the routing tags as a Set of RoutingTag
      Since:
      12.27

    • addRoutingTags

      UserModifier addRoutingTags(RoutingTag... routingTags) throws ValidationException

      Add the passed routing tags to the user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      routingTags - the routing tags that should be added
      Returns:
      the UserModifier
      Throws:
      ValidationException - if a routing tag is null
      Since:
      12.27

    • removeRoutingTags

      UserModifier removeRoutingTags(RoutingTag... routingTags) throws ValidationException

      Remove the passed routing tags of the user.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      routingTags - the routing tags that should be removed
      Returns:
      the UserModifier
      Throws:
      ValidationException - if a routing tag is null
      Since:
      12.27