## Uses of Interface
org.activiti.engine.identity.UserQuery

- Packages that use UserQuery
  Package | Description
  --- | ---
  org.activiti.engine | Public API of the Activiti engine. Typical usage of the API starts by the creation of a `ProcessEngineConfiguration` (typically based on a configuration file), from which a `ProcessEngine` can be obtained. Through the services obtained from such a `ProcessEngine`, BPM and workflow operation can be executed: `RepositoryService`: Manages `Deployment`s `RuntimeService`: For starting and searching `ProcessInstance`s `TaskService`: Exposes operations to manage human (standalone) `Task`s, such as claiming, completing and assigning tasks `IdentityService`: Used for managing `User`s, `Group`s and the relations between them `ManagementService`: Exposes engine admin and maintenance operations, which have no relation to the runtime exection of business processes `HistoryService`: Exposes information about ongoing and past process instances. `FormService`: Access to form data and rendered forms for starting new process instances and completing tasks.
  org.activiti.engine.identity | classes related to the `IdentityService`.

- - ### Uses of UserQuery in org.activiti.engine

    Methods in org.activiti.engine that return UserQuery
    Modifier and Type | Method and Description
    --- | ---
    `UserQuery` | IdentityService.`createUserQuery()` Creates a `UserQuery` that allows to programmatically query the users.

  - ### Uses of UserQuery in org.activiti.engine.identity

    Methods in org.activiti.engine.identity that return UserQuery
    Modifier and Type | Method and Description
    --- | ---
    `UserQuery` | UserQuery.`memberOfGroup(String groupId)` Only select `User`s that belong to the given group.
    `UserQuery` | UserQuery.`orderByUserEmail()` Order by user email (needs to be followed by `Query.asc()` or `Query.desc()`).
    `UserQuery` | UserQuery.`orderByUserFirstName()` Order by user first name (needs to be followed by `Query.asc()` or `Query.desc()`).
    `UserQuery` | UserQuery.`orderByUserId()` Order by user id (needs to be followed by `Query.asc()` or `Query.desc()`).
    `UserQuery` | UserQuery.`orderByUserLastName()` Order by user last name (needs to be followed by `Query.asc()` or `Query.desc()`).
    `UserQuery` | UserQuery.`potentialStarter(String procDefId)` Only select `User`S that are potential starter for the given process definition.
    `UserQuery` | UserQuery.`userEmail(String email)` Only those `User`s with the given email addres.
    `UserQuery` | UserQuery.`userEmailLike(String emailLike)` Only select `User`s where the email matches the given parameter.
    `UserQuery` | UserQuery.`userFirstName(String firstName)` Only select `User`s with the given firstName.
    `UserQuery` | UserQuery.`userFirstNameLike(String firstNameLike)` Only select `User`s where the first name matches the given parameter.
    `UserQuery` | UserQuery.`userFullNameLike(String fullNameLike)` Only select `User`s where the full name matches the given parameters.
    `UserQuery` | UserQuery.`userId(String id)` Only select `User`s with the given id/
    `UserQuery` | UserQuery.`userLastName(String lastName)` Only select `User`s with the given lastName.
    `UserQuery` | UserQuery.`userLastNameLike(String lastNameLike)` Only select `User`s where the last name matches the given parameter.

Copyright © 2016 Alfresco. All rights reserved.