Package org.exoplatform.services.organization.search

Interface UserSearchService

All Known Implementing Classes:
UserSearchServiceImpl
public interface UserSearchService
This Service is used to centralize the search of users

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.exoplatform.commons.utils.ListAccess<org.exoplatform.services.organization.User>
    searchUsers(String term)
    Search users by a term and having status = ENABLED
    org.exoplatform.commons.utils.ListAccess<org.exoplatform.services.organization.User>
    searchUsers(String term, org.exoplatform.services.organization.UserStatus userStatus)
    Search users by a term and its status: ENABLED, DISABLED or ALL

  • Method Details

    • searchUsers

      default org.exoplatform.commons.utils.ListAccess<org.exoplatform.services.organization.User> searchUsers(String term) throws Exception
      Search users by a term and having status = ENABLED
      Parameters:
      term - query string that will be used to search in user name
      Returns:
      ListAccess of User
      Throws:
      Exception

    • searchUsers

      org.exoplatform.commons.utils.ListAccess<org.exoplatform.services.organization.User> searchUsers(String term, org.exoplatform.services.organization.UserStatus userStatus) throws Exception
      Search users by a term and its status: ENABLED, DISABLED or ALL
      Parameters:
      term - query string that will be used to search in user name
      userStatus - user status of type UserStatus
      Returns:
      ListAccess of User
      Throws:
      Exception