UserProfileService (Nuxeo 2021.64.6 API Documentation)

All Known Implementing Classes:

UserProfileServiceImpl
```
public interface UserProfileService
```
A service to manage user profiles

Since:

5.5

Author:

Quentin Lamerand

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearCache()`	Clears the user profile cache.
`ImporterConfig`	`getImporterConfig()`	Get the user profile XMap descriptor for the importer config
`DocumentModel`	`getUserProfile(DocumentModel userModel, CoreSession session)`	Get a DocumentModel containing both user and user profile schemas
`DocumentModel`	`getUserProfileDocument(String userName, CoreSession session)`	Get the profile of a specific user.
`DocumentModel`	`getUserProfileDocument(CoreSession session)`	Get the current user profile.

- Method Detail
  - getUserProfileDocument
```
DocumentModel getUserProfileDocument(CoreSession session)
```
    Get the current user profile. It's stored in its user workspace.
    
    Parameters:
    
    session - the current CoreSession
    
    Returns:
    
    the user profile DocumentModel
  - getUserProfileDocument
```
DocumentModel getUserProfileDocument(String userName,
                                     CoreSession session)
```
    Get the profile of a specific user. It's stored in its user workspace.
    
    Parameters:
    
    userName - the user name
    
    session - the current CoreSession
    
    Returns:
    
    the user profile DocumentModel
  - getUserProfile
```
DocumentModel getUserProfile(DocumentModel userModel,
                             CoreSession session)
```
    Get a DocumentModel containing both user and user profile schemas
    
    Parameters:
    
    userModel - the user DocumentModel
    
    session - the current CoreSession
    
    Returns:
    
    a SimpleDocumentModel with the two schemas
  - clearCache
```
void clearCache()
```
    Clears the user profile cache.
  - getImporterConfig
```
ImporterConfig getImporterConfig()
```
    Get the user profile XMap descriptor for the importer config
    
    Returns:
    
    an XMap ImportConfig descriptor