Interface User
- All Superinterfaces:
Comparable<com.novomind.ecom.common.api.persistence.Entity>,com.novomind.ecom.common.api.persistence.Entity,MasterEntity,com.novomind.ecom.common.api.attribute.Named,OptionalLocationProvider,StorageProvider,SystemGroupAssigned,com.novomind.ecom.common.api.persistence.WithId
public interface User
extends MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider, OptionalLocationProvider, SystemGroupAssigned
Represents a registered user
- Since:
- 10.0.28
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumThis enumeration describes the category visibility mode for a user -
Method Summary
Modifier and TypeMethodDescriptionReturns the assignments of this user to agent groups with the individual skills.Returns theCategoryModefor the automatic routing.Returns the email address of the user in the form local-part@domain (see https://tools.ietf.org/html/rfc5322#section-3.4.1)Returns a set ofLocaleof the user's language skills.Returns the locale of this userReturns theCategoryModefor the manual routing.Returns theCategoryModefor the manual routing of clearance authorizations.intReturns the maximum number of chats that should be routed to this user.intReturns the maximum number of mails that should be routed to this user.Returns an unmodifiable set of the currently assigned routing tags.Returns the user's signature.Returns the username of the userbooleanReturns true if the user has clearance authority, otherwise false.booleanisAgent()Returns true, if the user is an agent, otherwise false.booleanReturns true if the routing of calls is enabled for this user, otherwise false.booleanReturns true if a clearance is required, otherwise false.booleanisLocked()Returns true if user is locked, otherwise false.Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity
compareTo, isDeleted, isNotDeletedMethods inherited from interface com.novomind.ecom.common.api.attribute.Named
getNameMethods inherited from interface com.novomind.ecom.api.iagent.provider.OptionalLocationProvider
getLocationMethods inherited from interface com.novomind.ecom.api.iagent.provider.StorageProvider
getStorageMethods inherited from interface com.novomind.ecom.api.iagent.assignment.SystemGroupAssigned
getAssignedSystemGroupsMethods inherited from interface com.novomind.ecom.common.api.persistence.WithId
getId
-
Method Details
-
getUsername
String getUsername()Returns the username of the user- Returns:
- the username as String
- Since:
- 10.0.28
-
getAgentGroupAssignments
Set<UserAgentGroupAssignment> getAgentGroupAssignments()Returns the assignments of this user to agent groups with the individual skills.- Returns:
- the assignments of this user to agent groups with the individual skills
- Since:
- 10.0.108
-
getLocale
Locale getLocale()Returns the locale of this user- Returns:
- the locale of this user
- Since:
- 10.0.124
-
getEmailAddress
String getEmailAddress()Returns the email address of the user in the form local-part@domain (see https://tools.ietf.org/html/rfc5322#section-3.4.1)- 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
-
isAgent
boolean isAgent()Returns true, if the user is an agent, otherwise false.- Returns:
- true, if the user is an agent, otherwise false.
- Since:
- 11.22
-
getRoutingTags
Set<RoutingTag> getRoutingTags()Returns an unmodifiable set of the currently assigned routing tags.
The returned set is not updated when assignments change.- Returns:
- the current assigned routing tags as an unmodifiable set
- Since:
- 12.0
-
isClearanceRequired
boolean isClearanceRequired()Returns true if a clearance is required, otherwise false.- Returns:
- true if a clearance is required, otherwise false
- Since:
- 12.2
-
hasClearanceAuthority
boolean hasClearanceAuthority()Returns true if the user has clearance authority, otherwise false.- Returns:
- true if the user has clearance authority, otherwise false
- Since:
- 13.0
-
getMaxMails
int getMaxMails()Returns the maximum number of mails that should be routed to this user.- Returns:
- the maximum number of mails that should be routed to this user
- Since:
- 12.2
-
getMaxChats
int getMaxChats()Returns the maximum number of chats that should be routed to this user.- Returns:
- the maximum number of chats that should be routed to this user
- Since:
- 12.2
-
getAutoRoutingCategoryMode
User.CategoryMode getAutoRoutingCategoryMode()Returns theCategoryModefor the automatic routing.- Returns:
- the
CategoryModefor the automatic routing - Since:
- 12.2
-
getManualRoutingCategoryMode
User.CategoryMode getManualRoutingCategoryMode()Returns theCategoryModefor the manual routing.- Returns:
- the
CategoryModefor the manual routing - Since:
- 12.2
-
getManualRoutingClearanceAuthorizationCategoryMode
User.CategoryMode getManualRoutingClearanceAuthorizationCategoryMode()Returns theCategoryModefor the manual routing of clearance authorizations.- Returns:
- the
CategoryModefor the manual routing of clearance authorizations - Since:
- 13.0
-
isCallRoutingEnabled
boolean isCallRoutingEnabled()Returns true if the routing of calls is enabled for this user, otherwise false.- Returns:
- true if the routing of calls is enabled for this user, otherwise false
- Since:
- 13.0
-
isLocked
boolean isLocked()Returns true if user is locked, otherwise false.- Returns:
- true if user is locked, otherwise false
- Since:
- 12.27
-
getSignature
String getSignature()Returns the user's signature.- Returns:
- the user's signature
- Since:
- 12.27
-
getLanguageSkills
Returns a set ofLocaleof the user's language skills.- Returns:
- a set of
Localeof the user's language skills - Since:
- 12.27
-