Interface User
-
- All Superinterfaces:
java.lang.Comparable<com.novomind.ecom.common.api.persistence.Entity>
,com.novomind.ecom.common.api.persistence.Entity
,LocationProvider
,MasterEntity
,com.novomind.ecom.common.api.attribute.Named
,StorageProvider
,SystemGroupAssigned
public interface User extends MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider, LocationProvider, SystemGroupAssigned
Represents a registered user- Since:
- 10.0.28
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
User.CategoryMode
This enumeration describes the category visibility mode for a user
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<UserAgentGroupAssignment>
getAgentGroupAssignments()
User.CategoryMode
getAutoRoutingCategoryMode()
java.lang.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)java.util.Set<java.util.Locale>
getLanguageSkills()
java.util.Locale
getLocale()
Returns the locale of this userUser.CategoryMode
getManualRoutingCategoryMode()
int
getMaxChats()
int
getMaxMails()
java.util.Set<RoutingTag>
getRoutingTags()
Returns an unmodifiable set of the currently assigned routing tags.java.lang.String
getSignature()
java.lang.String
getUsername()
Returns the username of the userboolean
isAgent()
Returns true, if the user is an agent, otherwise false.boolean
isClearanceRequired()
boolean
isLocked()
-
Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity
compareTo, getId, isDeleted, isNotDeleted
-
Methods inherited from interface com.novomind.ecom.api.iagent.provider.LocationProvider
getLocation
-
Methods inherited from interface com.novomind.ecom.api.iagent.provider.StorageProvider
getStorage
-
Methods inherited from interface com.novomind.ecom.api.iagent.assignment.SystemGroupAssigned
getAssignedSystemGroups
-
-
-
-
Method Detail
-
getUsername
java.lang.String getUsername()
Returns the username of the user- Returns:
- the username as String
- Since:
- 10.0.28
-
getAgentGroupAssignments
java.util.Set<UserAgentGroupAssignment> getAgentGroupAssignments()
- Returns:
- the assignments of this user to agent groups with the individual skills
- Since:
- 10.0.108
-
getLocale
java.util.Locale getLocale()
Returns the locale of this user- Returns:
- the locale of this user
- Since:
- 10.0.124
-
getEmailAddress
java.lang.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
java.util.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
- Since:
- 12.2
-
getMaxMails
int getMaxMails()
- 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
- Since:
- 12.2
-
getAutoRoutingCategoryMode
User.CategoryMode getAutoRoutingCategoryMode()
- Returns:
- the
CategoryMode
for the automatic routing - Since:
- 12.2
-
getManualRoutingCategoryMode
User.CategoryMode getManualRoutingCategoryMode()
- Returns:
- the
CategoryMode
for the manual routing - Since:
- 12.2
-
isLocked
boolean isLocked()
- Returns:
- true if user is locked, otherwise false
- Since:
- 12.27
-
getSignature
java.lang.String getSignature()
- Returns:
- the user's signature
- Since:
- 12.27
-
getLanguageSkills
java.util.Set<java.util.Locale> getLanguageSkills()
- Returns:
- a set of
Locale
of the user's language skills - Since:
- 12.27
-
-