UserQueryParameters (Communote 3.5 API)

java.lang.Object
- com.communote.server.core.vo.query.QueryParameters
- - com.communote.server.core.vo.query.PropertyQueryParameters
  - - com.communote.server.core.vo.query.user.UserQueryParameters

Direct Known Subclasses:

BlogMemberManagementQueryParameters, BlogMemberQueryParameters, CommunoteEntityQueryParameters, TimelineQueryParameters, UserManagementQueryParameters, UserQueryParameters, UserTagQueryParameters
```
public class UserQueryParameters
extends PropertyQueryParameters
```
Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary
- Nested classes/interfaces inherited from class com.communote.server.core.vo.query.QueryParameters
  QueryParameters.OrderDirection

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_LAST_MODIFICATION_DATE` the parameter name for the last modification date
`static String`	`PARAM_TAG_PREFIX` the parameter for tag prefix filtering
`static String`	`PARAM_USER_ROLE_FILTER`
`static String`	`PLACEHOLDER_USER_ALIAS` Placeholder for the user alias, which is used for sorting and will be replaced by the query.

Fields inherited from class com.communote.server.core.vo.query.QueryParameters
SORT_ASCENDING, SORT_DESCENDING

Constructor Summary

Constructors
Constructor and Description
`UserQueryParameters()` Create parameters for configuring the user query.
`UserQueryParameters(int maxCount, int offset)` Create parameters for configuring the user query.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRoleToExclude(UserRole role)` Add a role to exclude in the result.
`void`	`addRoleToInclude(UserRole role)` Add a role to include in the result.
`void`	`addUserTagIds(Long... tagIds)` Adds a tag by its id the users should be tagged with.
`void`	`addUserTagStoreTagId(String tagStoreAlias, Collection<String> tagStoreTagIds)` Adds a list of tags for a specific TagStore the users should be tagged with.
`void`	`addUserTagStoreTagId(String tagStoreAlias, String tagStoreTagId)` Adds a tag for a specific TagStore the users should be tagged with.
`UserStatus[]`	`getExcludeStatusFilter()`
`UserStatus[]`	`getIncludeStatusFilter()` Gets the status filter.
`Timestamp`	`getLastModifiedAfter()`
`org.hibernate.criterion.MatchMode`	`getMatchMode()` Returns the match mode used in user name based queries.
`Map<String,Object>`	`getParameters()` Get the parameters of this instances, the names are the keys
`Collection<UserRole>`	`getRolesToExclude()`
`Collection<UserRole>`	`getRolesToInclude()`
`String`	`getTagPrefix()`
`Set<String>`	`getTagStoreAliases()`
`String[]`	`getUserSearchFilters()` Get the user search strings
`String[]`	`getUserSearchParameterNames()`
`Set<Long>`	`getUserTagIds()`
`Map<String,Set<String>>`	`getUserTagStoreTagIds()`
`boolean`	`isHideSelectedTags()`
`boolean`	`isIgnoreEmailField()` Returns whether to include the email field in the search.
`boolean`	`isMultilingualTagPrefixSearch()`
`boolean`	`isRetrieveOnlyFollowedUsers()`
`boolean`	`needTransformListItem()`
`void`	`setExcludeStatusFilter(UserStatus[] excludeStatusFilter)`
`void`	`setHideSelectedTags(boolean hideSelectedTags)`
`void`	`setIncludeStatusFilter(UserStatus[] includeStatusFilter)` Sets the status filter.
`void`	`setLastModifiedAfter(Timestamp lastModifiedAfter)`
`void`	`setMatchMode(org.hibernate.criterion.MatchMode mode)` Sets the match mode for name queries.
`void`	`setRetrieveOnlyFollowedUsers(boolean onlyFollowedUsers)` Set whether to retrieve only users followed by the current user.
`void`	`setTagPrefix(String tagPrefix)`
`void`	`setTagStoreAliases(Set<String> tagStoreAliases)` Set aliases of tag stores to only consider tags from these stores
`void`	`setUserSearchFilters(String[] userSearchFilters)` Searches the user fields without email.
`void`	`setUserSearchFilters(String[] userSearchFilters, boolean includeEmailFieldInSearch)` Sets the user search string.
`void`	`sortByEmailAsc()` Sort by the last name ascending
`void`	`sortByFirstNameAsc()` Sort by the first name ascending
`void`	`sortByLastNameAsc()` Sort by the email ascending
`IdentifiableEntityData`	`transformResultItem(Object resultItem)` Deprecated. User UserToUserDataQueryResultConverter instead.

Methods inherited from class com.communote.server.core.vo.query.PropertyQueryParameters
addPropertyFilter, getPropertyFilters

Methods inherited from class com.communote.server.core.vo.query.QueryParameters
addParameter, addParameter, addSortField, addSortField, createParameterNamesForSearch, getDatabaseConfiguration, getLanguageCode, getPageInformation, getPageInformation, getResultSpecification, getSortString, isLimitResultSet, isLimitResultSetAvodingDuplicates, putParameter, putParametersForSearch, putParametersForSearch, setLanguageCode, setLimitResultSet, setLimitResultSetAvodingDuplicates, setResultSpecification, validateLong

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

- Field Detail
  - PLACEHOLDER_USER_ALIAS
```
public static final String PLACEHOLDER_USER_ALIAS
```
    Placeholder for the user alias, which is used for sorting and will be replaced by the query.
    
    See Also:
    
    Constant Field Values
  - PARAM_USER_ROLE_FILTER
```
public static final String PARAM_USER_ROLE_FILTER
```
    See Also:
    
    Constant Field Values
  - PARAM_LAST_MODIFICATION_DATE
```
public static final String PARAM_LAST_MODIFICATION_DATE
```
    the parameter name for the last modification date
    
    See Also:
    
    Constant Field Values
  - PARAM_TAG_PREFIX
```
public static final String PARAM_TAG_PREFIX
```
    the parameter for tag prefix filtering
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserQueryParameters
```
public UserQueryParameters()
```
    Create parameters for configuring the user query. Uses as maxCount and 0 as offset.
    
    See Also:
    
    UserQueryParameters(int, int)
  - UserQueryParameters
```
public UserQueryParameters(int maxCount,
                           int offset)
```
    Create parameters for configuring the user query.
    
    Parameters:
    
    maxCount - the upper limit of users to retrieve. A value of less than or equal to 0 means no limit.
    
    offset - the offset in the result set from where matches should be retrieved
- Method Detail
  - addRoleToExclude
```
public void addRoleToExclude(UserRole role)
```
    Add a role to exclude in the result.
    
    Parameters:
    
    role - the role to exclude
    
    See Also:
    
    getRolesToExclude()
  - addRoleToInclude
```
public void addRoleToInclude(UserRole role)
```
    Add a role to include in the result.
    
    Parameters:
    
    role - the role to include
    
    See Also:
    
    getRolesToInclude()
  - addUserTagIds
```
public void addUserTagIds(Long... tagIds)
```
    Adds a tag by its id the users should be tagged with.
    
    Parameters:
    
    tagIds - TagIds to filter for.
  - addUserTagStoreTagId
```
public void addUserTagStoreTagId(String tagStoreAlias,
                                 Collection<String> tagStoreTagIds)
```
    Adds a list of tags for a specific TagStore the users should be tagged with.
    
    Parameters:
    
    tagStoreAlias - The alias of the TagStore.
    
    tagStoreTagIds - Collection of tag ids to add for the given TagStore.
  - addUserTagStoreTagId
```
public void addUserTagStoreTagId(String tagStoreAlias,
                                 String tagStoreTagId)
```
    Adds a tag for a specific TagStore the users should be tagged with.
    
    Parameters:
    
    tagStoreAlias - The alias of the TagStore.
    
    tagStoreTagId - The id of the tag within the TagStore.
  - getExcludeStatusFilter
```
public UserStatus[] getExcludeStatusFilter()
```
    Returns:
    
    the user status to exclude
  - getIncludeStatusFilter
```
public UserStatus[] getIncludeStatusFilter()
```
    Gets the status filter.
    
    Returns:
    
    the includeStatusFilter
  - getLastModifiedAfter
```
public Timestamp getLastModifiedAfter()
```
    Returns:
    
    the lastModifiedAfter
  - getMatchMode
```
public org.hibernate.criterion.MatchMode getMatchMode()
```
    Returns the match mode used in user name based queries. The default is MatchMode.ANYWHERE.
    
    Returns:
    
    the match mode
  - getParameters
```
public Map<String,Object> getParameters()
```
    Get the parameters of this instances, the names are the keys
    
    Overrides:
    
    getParameters in class PropertyQueryParameters
    
    Returns:
    
    The parameters
  - getRolesToExclude
```
public Collection<UserRole> getRolesToExclude()
```
    Returns:
    
    the roles of users to exclude in the result. If empty no roles are excluded. If also roles to include are defined the roles to exclude are ignored.
  - getRolesToInclude
```
public Collection<UserRole> getRolesToInclude()
```
    Returns:
    
    the roles of users to include in the result. If empty all roles are included.
  - getTagPrefix
```
public String getTagPrefix()
```
    Returns:
    
    the tagPrefix
  - getTagStoreAliases
```
public Set<String> getTagStoreAliases()
```
    Returns:
    
    set of aliases identifying tag stores
  - getUserSearchFilters
```
public String[] getUserSearchFilters()
```
    Get the user search strings
    
    Returns:
    
    the user search strings
  - getUserSearchParameterNames
```
public String[] getUserSearchParameterNames()
```
    Returns:
    
    the parameter names to be used in a user search or null if no user search filter was set
  - getUserTagIds
```
public Set<Long> getUserTagIds()
```
    Returns:
    
    the tagIds
  - getUserTagStoreTagIds
```
public Map<String,Set<String>> getUserTagStoreTagIds()
```
    Returns:
    
    the tagStoreTagIds
  - isHideSelectedTags
```
public boolean isHideSelectedTags()
```
    Returns:
    
    the hideSelectedTags
  - isIgnoreEmailField
```
public boolean isIgnoreEmailField()
```
    Returns whether to include the email field in the search.
    
    Returns:
    
    the ignoreEmailField
  - isMultilingualTagPrefixSearch
```
public boolean isMultilingualTagPrefixSearch()
```
    Returns:
    
    true if a tag prefix query should check the translations of tags
  - isRetrieveOnlyFollowedUsers
```
public boolean isRetrieveOnlyFollowedUsers()
```
    Returns:
    
    whether to retrieve only users followed by the current user.
  - needTransformListItem
```
public boolean needTransformListItem()
```
    Overrides:
    
    needTransformListItem in class QueryParameters
    
    Returns:
    
    true if the transform list item function should be used after retrieving the objects
  - setExcludeStatusFilter
```
public void setExcludeStatusFilter(UserStatus[] excludeStatusFilter)
```
    Parameters:
    
    excludeStatusFilter - the user status to ignore
  - setHideSelectedTags
```
public void setHideSelectedTags(boolean hideSelectedTags)
```
    Parameters:
    
    hideSelectedTags - the hideSelectedTags to set
  - setIncludeStatusFilter
```
public void setIncludeStatusFilter(UserStatus[] includeStatusFilter)
```
    Sets the status filter.
    
    Parameters:
    
    includeStatusFilter - the includeStatusFilter to set
  - setLastModifiedAfter
```
public void setLastModifiedAfter(Timestamp lastModifiedAfter)
```
    Parameters:
    
    lastModifiedAfter - the lastModifiedAfter to set
  - setMatchMode
```
public void setMatchMode(org.hibernate.criterion.MatchMode mode)
```
    Sets the match mode for name queries.
    
    Parameters:
    
    mode - the match mode
  - setRetrieveOnlyFollowedUsers
```
public void setRetrieveOnlyFollowedUsers(boolean onlyFollowedUsers)
```
    Set whether to retrieve only users followed by the current user.
    
    Parameters:
    
    onlyFollowedUsers - true to retrieve only followed users
  - setTagPrefix
```
public void setTagPrefix(String tagPrefix)
```
    Parameters:
    
    tagPrefix - the tagPrefix to set
  - setTagStoreAliases
```
public void setTagStoreAliases(Set<String> tagStoreAliases)
```
    Set aliases of tag stores to only consider tags from these stores
    
    Parameters:
    
    tagStoreAliases - set of aliases identifying tag stores
  - setUserSearchFilters
```
public void setUserSearchFilters(String[] userSearchFilters)
```
    Searches the user fields without email. See also setUserSearchFilters(String[], boolean)
    
    Parameters:
    
    userSearchFilters - the user search strings
  - setUserSearchFilters
```
public void setUserSearchFilters(String[] userSearchFilters,
                                 boolean includeEmailFieldInSearch)
```
    Sets the user search string. If set the user must match either first, last or email. Each String in the array is "AND" connected, eg. {'user','bla'} finds all users having somewhere in their name or email 'user' AND 'bla'
    
    Parameters:
    
    userSearchFilters - the user search string
    
    includeEmailFieldInSearch - true if the email field should be included in search
  - sortByEmailAsc
```
public void sortByEmailAsc()
```
    Sort by the last name ascending
  - sortByFirstNameAsc
```
public void sortByFirstNameAsc()
```
    Sort by the first name ascending
  - sortByLastNameAsc
```
public void sortByLastNameAsc()
```
    Sort by the email ascending
  - transformResultItem
```
@Deprecated
public IdentifiableEntityData transformResultItem(Object resultItem)
```
    Deprecated. User UserToUserDataQueryResultConverter instead.
    
    transform the list item after it has been loaded and filled by the query definition
    
    Overrides:
    
    transformResultItem in class QueryParameters
    
    Parameters:
    
    resultItem - the item to transform
    
    Returns:
    
    the transformed list item

Class UserQueryParameters

Nested Class Summary

Nested classes/interfaces inherited from class com.communote.server.core.vo.query.QueryParameters

Field Summary

Fields inherited from class com.communote.server.core.vo.query.QueryParameters

Constructor Summary

Method Summary

Methods inherited from class com.communote.server.core.vo.query.PropertyQueryParameters

Methods inherited from class com.communote.server.core.vo.query.QueryParameters

Methods inherited from class java.lang.Object

Field Detail

PLACEHOLDER_USER_ALIAS

PARAM_USER_ROLE_FILTER

PARAM_LAST_MODIFICATION_DATE

PARAM_TAG_PREFIX

Constructor Detail

UserQueryParameters

UserQueryParameters

Method Detail

addRoleToExclude

addRoleToInclude

addUserTagIds

addUserTagStoreTagId

addUserTagStoreTagId

getExcludeStatusFilter

getIncludeStatusFilter

getLastModifiedAfter

getMatchMode

getParameters

getRolesToExclude

getRolesToInclude

getTagPrefix

getTagStoreAliases

getUserSearchFilters

getUserSearchParameterNames

getUserTagIds

getUserTagStoreTagIds

isHideSelectedTags

isIgnoreEmailField

isMultilingualTagPrefixSearch

isRetrieveOnlyFollowedUsers

needTransformListItem

setExcludeStatusFilter

setHideSelectedTags

setIncludeStatusFilter

setLastModifiedAfter

setMatchMode

setRetrieveOnlyFollowedUsers

setTagPrefix

setTagStoreAliases

setUserSearchFilters

setUserSearchFilters

sortByEmailAsc

sortByFirstNameAsc

sortByLastNameAsc

transformResultItem