Package lumis.portal.user

Interface IUserManagerSPI

  • All Superinterfaces:
    IConfigDeleter, IUserManager
    All Known Implementing Classes:
    UserManager
    public interface IUserManagerSPI
extends IUserManager
    Class interface responsible for managing internal operations on the portal users.
    Since:
    8.0.0
    Version:
    $Revision: 22845 $ $Date: 2019-06-19 16:14:36 -0300 (Wed, 19 Jun 2019) $

    • Method Detail

      • getUserProfileImageHref

        java.lang.String getUserProfileImageHref​(java.lang.String userId)
        Get user profile image href by user identifier
        Parameters:
        userId - the user identifier
        Returns:
        user profile image href
        Since:
        8.0.0

      • getUserProfileImageContentTypeFile

        IFile getUserProfileImageContentTypeFile​(java.lang.String userId)
        Returns the user's profile image content type file.
        Parameters:
        userId - the user identifier.
        Returns:
        the user's profile image content type file.
        Since:
        8.0.0

      • getUserProfileImageFile

        IFile getUserProfileImageFile​(java.lang.String userId)
        Returns the user's profile image file.
        Parameters:
        userId - the user identifier.
        Returns:
        the user's profile image file.
        Since:
        8.0.0

      • findUsers

        default java.util.List<UserConfig> findUsers​(java.lang.String query)
                                      throws PortalException
        Find the first five users which are not framework users, given a search query for user login or user name.
        Parameters:
        query - query used to search users
        Returns:
        List of users which matches the search query.
        Throws:
        PortalException
        Since:
        10.1.0
        See Also:
        findUsers(String, boolean, int)

      • findUsers

        java.util.List<UserConfig> findUsers​(java.lang.String query,
                                     boolean includeFrameworkUsers,
                                     int maxResults)
                              throws PortalException
        Find users by user login or user name, given a search query.
        Parameters:
        query - query used to search users
        includeFrameworkUsers - indicates if framework users must also be returned
        maxResults - amount of users to return
        Returns:
        List of users which matches the search query with the given parameters.
        Throws:
        PortalException
        Since:
        10.1.0
        See Also:
        IUserDao.findUsers(String, boolean, int)