Package org.nuxeo.ecm.automation.core.operations.users

Class SuggestUserEntries

java.lang.Object

org.nuxeo.ecm.automation.core.operations.users.SuggestUserEntries

public class SuggestUserEntries
extends Object

SuggestUser Operation.

Since:

5.7.3

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowSubGroupsRestriction
protected OperationContext	ctx
protected DirectoryService	directoryService
protected boolean	displayEmailInSuggestion
protected String	firstLabelField
protected String	groupRestriction
protected boolean	hideAdminGroups
protected boolean	hideFirstLabel
protected boolean	hideIcon
protected boolean	hidePowerUsersGroup
protected boolean	hideSecondLabel
protected boolean	hideThirdLabel
static String	ID
protected String	lang
static String	POWERUSERS
protected String	prefix
protected SchemaManager	schemaManager
protected String	searchType
protected String	secondLabelField
protected String	thirdLabelField
protected UserManager	userManager
protected Integer	userSuggestionMaxSearchResults

Constructor Summary

Constructors

Constructor	Description
SuggestUserEntries()

Method Summary

Modifier and Type	Method	Description
protected String	getLang()
protected Locale	getLocale()
protected MultiExpression	getUserSearchPredicate(String prefix)
Blob	run()
protected DocumentModelList	searchUsers(long limit)	Performs a full name user search, e.g.
protected DocumentModelList	searchUsers(MultiExpression multiExpression, long limit)
protected List<Map<String,Object>>	usersToMapWithGroupRestrictions(DocumentModelList userList)	Applies group restrictions, and returns Map objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

POWERUSERS

public static final String POWERUSERS

See Also:

Constant Field Values

ctx

protected OperationContext ctx

schemaManager

protected SchemaManager schemaManager

prefix

protected String prefix

searchType

protected String searchType

groupRestriction

protected String groupRestriction

hideAdminGroups

protected boolean hideAdminGroups

Since:

7.10

hidePowerUsersGroup

protected boolean hidePowerUsersGroup

Since:

8.3

userSuggestionMaxSearchResults

protected Integer userSuggestionMaxSearchResults

firstLabelField

protected String firstLabelField

secondLabelField

protected String secondLabelField

thirdLabelField

protected String thirdLabelField

hideFirstLabel

protected boolean hideFirstLabel

hideSecondLabel

protected boolean hideSecondLabel

hideThirdLabel

protected boolean hideThirdLabel

displayEmailInSuggestion

protected boolean displayEmailInSuggestion

hideIcon

protected boolean hideIcon

userManager

protected UserManager userManager

directoryService

protected DirectoryService directoryService

lang

protected String lang

allowSubGroupsRestriction

protected boolean allowSubGroupsRestriction

Constructor Detail

SuggestUserEntries

public SuggestUserEntries()

Method Detail

run

public Blob run()
         throws IOException

Throws:

IOException

usersToMapWithGroupRestrictions

protected List<Map<String,Object>> usersToMapWithGroupRestrictions(DocumentModelList userList)

Applies group restrictions, and returns Map objects.

searchUsers

protected DocumentModelList searchUsers(long limit)

Performs a full name user search, e.g. typing "John Do" returns the user with first name "John" and last name "Doe". Typing "John" returns the "John Doe" user and possibly other users such as "John Foo". Respectively, typing "Do" returns the "John Doe" user and possibly other users such as "Jack Donald".

searchUsers

protected DocumentModelList searchUsers(MultiExpression multiExpression,
                                        long limit)

getUserSearchPredicate

protected MultiExpression getUserSearchPredicate(String prefix)

getLang

protected String getLang()

getLocale

protected Locale getLocale()