Class FindUsersRequest

  • All Implemented Interfaces:
    Serializable

    public class FindUsersRequest
    extends PagedRequest
    The search criteria for users.

    Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

    The returned users satisfy all constraints that are specified in this search criteria.

    By default a result containing 1000 users is returned.

    See Also:
    Serialized Form
    • Constructor Detail

      • FindUsersRequest

        public FindUsersRequest()
    • Method Detail

      • getUserIds

        public List<String> getUserIds()
        The IDs of the users.
      • getName

        public String getName()
        The name of the user. The search will take place in the fields specified by the 'nameSearchFields' parameter.
      • getGroupId

        public UUID getGroupId()
        The ID of the group the searched users should belong to.
      • isOnlyLoggedIn

        public boolean isOnlyLoggedIn()
        Whether only currently logged in users should be returned.
      • isIncludeDisabled

        public boolean isIncludeDisabled()
        Whether disabled users should be included in the search results.
      • getSortOrder

        public SortOrder getSortOrder()
      • setUserIds

        public void setUserIds​(List<String> userIds)
        The IDs of the users.
      • setName

        public void setName​(String name)
        The name of the user. The search will take place in the fields specified by the 'nameSearchFields' parameter.
      • setGroupId

        public void setGroupId​(UUID groupId)
        The ID of the group the searched users should belong to.
      • setOnlyLoggedIn

        public void setOnlyLoggedIn​(boolean onlyLoggedIn)
        Whether only currently logged in users should be returned.
      • setIncludeDisabled

        public void setIncludeDisabled​(boolean includeDisabled)
        Whether disabled users should be included in the search results.
      • setSortOrder

        public void setSortOrder​(SortOrder sortOrder)
      • canEqual

        protected boolean canEqual​(Object other)
        Overrides:
        canEqual in class PagedRequest