CmsJpaUserQueryBuilder

java.lang.Object
- org.opencms.db.generic.CmsUserQueryBuilder
- - org.opencms.db.jpa.CmsJpaUserQueryBuilder

```
public class CmsJpaUserQueryBuilder
extends CmsUserQueryBuilder
```
User query builder implementation for JPA.

从以下版本开始:

8.0.0

构造器概要

构造器
构造器和说明

CmsJpaUserQueryBuilder()

构造器
构造器和说明
`CmsJpaUserQueryBuilder()`

方法概要

方法
限定符和类型	方法和说明
`protected void`	`addSorting(CmsSelectQuery select, CmsSelectQuery.TableAlias users, CmsUserSearchParameters searchParams)` Adds a sort order to an SQL query.
`protected java.lang.String`	`colDateCreated()` Column name accessor.
`protected java.lang.String`	`colEmail()` Column name accessor.
`protected java.lang.String`	`colFirstName()` Column name accessor.
`protected java.lang.String`	`colFlags()` Column name accessor.
`protected java.lang.String`	`colGroupUserGroupId()` Column name accessor.
`protected java.lang.String`	`colGroupUserUserId()` Column name accessor.
`protected java.lang.String`	`colId()` Column name accessor.
`protected java.lang.String`	`colLastLogin()` Column name accessor.
`protected java.lang.String`	`colLastName()` Column name accessor.
`protected java.lang.String`	`colName()` Column name accessor.
`protected java.lang.String`	`colOu()` Column name accessor.
`protected java.lang.String`	`colPassword()` Column name accessor.
`protected I_CmsQueryFragment`	`createFlagCondition(CmsSelectQuery.TableAlias users, int flags)` Creates an SQL flag check condition.
`protected java.lang.String`	`createSingleFlagCondition(java.lang.String col, int flag)` Creates the condition for matching a single flag.
`CmsPair<java.lang.String,java.util.List<java.lang.Object>>`	`createUserQuery(CmsUserSearchParameters searchParams, boolean countOnly)` Creates a query for searching users.
`protected java.lang.String`	`generateConcat(java.lang.String... expressions)` Generates an SQL expression for concatenating several other SQL expressions.
`protected java.lang.String`	`getGroupUserSubqueryColumns()` Returns the columns that should be returned by user subqueries.
`protected java.lang.String`	`internalCreateFlagCondition(java.lang.String col, int flags)` Helper method for creating a flag condition.
`protected java.lang.String`	`tabGroups()` Table name accessor.
`protected java.lang.String`	`tabGroupUsers()` Table name accessor.
`protected java.lang.String`	`tabUsers()` Table name accessor.
`protected java.util.List<java.lang.Integer>`	`uncompressFlags(int flags)` Uncompresses an integer used to store flags into its component flags.

从类继承的方法 org.opencms.db.generic.CmsUserQueryBuilder
addAllowedOuCondition, addFlagCondition, addGroupCondition, addOrgUnitCondition, addSearchFilterCondition, addWebuserCondition, createCoreCondition, generateTrim, getSortExpression, getUserActivatedExpression, getUserFlagExpression, getUserFullNameExpression, makePaged, shouldNameSubqueries, useWindowFunctionsForPaging, wrapLower

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CmsJpaUserQueryBuilder
```
public CmsJpaUserQueryBuilder()
```
- 方法详细资料
  - createUserQuery
```
public CmsPair<java.lang.String,java.util.List<java.lang.Object>> createUserQuery(CmsUserSearchParameters searchParams,
                                                                         boolean countOnly)
```
    Creates a query for searching users.
    
    覆盖:
    
    createUserQuery 在类中 CmsUserQueryBuilder
    
    参数:
    searchParams - the user search criteria
    countOnly - if true, the query will only count the total number of results instead of returning them
    
    返回:
    a pair consisting of the query string and its parameters
  - addSorting
```
protected void addSorting(CmsSelectQuery select,
              CmsSelectQuery.TableAlias users,
              CmsUserSearchParameters searchParams)
```
    Adds a sort order to an SQL query.
    
    覆盖:
    
    addSorting 在类中 CmsUserQueryBuilder
    
    参数:
    select - the query
    users - the user table alias
    searchParams - the user search criteria
  - colDateCreated
```
protected java.lang.String colDateCreated()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colDateCreated 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colDateCreated()
  - colEmail
```
protected java.lang.String colEmail()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colEmail 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colEmail()
  - colFirstName
```
protected java.lang.String colFirstName()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colFirstName 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colFirstName()
  - colFlags
```
protected java.lang.String colFlags()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colFlags 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colFlags()
  - colGroupUserGroupId
```
protected java.lang.String colGroupUserGroupId()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colGroupUserGroupId 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colGroupUserGroupId()
  - colGroupUserUserId
```
protected java.lang.String colGroupUserUserId()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colGroupUserUserId 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colGroupUserUserId()
  - colId
```
protected java.lang.String colId()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colId 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colId()
  - colLastLogin
```
protected java.lang.String colLastLogin()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colLastLogin 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colLastLogin()
  - colLastName
```
protected java.lang.String colLastName()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colLastName 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colLastName()
  - colName
```
protected java.lang.String colName()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colName 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colName()
  - colOu
```
protected java.lang.String colOu()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colOu 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colOu()
  - colPassword
```
protected java.lang.String colPassword()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Column name accessor.
    
    覆盖:
    
    colPassword 在类中 CmsUserQueryBuilder
    
    返回:
    the name of the column
    另请参阅:
    CmsUserQueryBuilder.colPassword()
  - createFlagCondition
```
protected I_CmsQueryFragment createFlagCondition(CmsSelectQuery.TableAlias users,
                                     int flags)
```
    从类复制的说明: CmsUserQueryBuilder
    
    Creates an SQL flag check condition.
    
    覆盖:
    
    createFlagCondition 在类中 CmsUserQueryBuilder
    
    参数:
    users - the user table alias
    flags - the flags to check
    
    返回:
    the resulting SQL expression
    另请参阅:
    CmsUserQueryBuilder.createFlagCondition(org.opencms.db.CmsSelectQuery.TableAlias, int)
  - createSingleFlagCondition
```
protected java.lang.String createSingleFlagCondition(java.lang.String col,
                                         int flag)
```
    Creates the condition for matching a single flag.
    
    参数:
    col - the column name
    flag - the flag
    
    返回:
    the single flag condition
  - generateConcat
```
protected java.lang.String generateConcat(java.lang.String... expressions)
```
    从类复制的说明: CmsUserQueryBuilder
    
    Generates an SQL expression for concatenating several other SQL expressions.
    
    覆盖:
    
    generateConcat 在类中 CmsUserQueryBuilder
    
    参数:
    expressions - the expressions to concatenate
    
    返回:
    the concat expression
    另请参阅:
    CmsUserQueryBuilder.generateConcat(java.lang.String[])
  - getGroupUserSubqueryColumns
```
protected java.lang.String getGroupUserSubqueryColumns()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Returns the columns that should be returned by user subqueries.
    
    覆盖:
    
    getGroupUserSubqueryColumns 在类中 CmsUserQueryBuilder
    
    返回:
    the columns that should be returned by user subqueries
    另请参阅:
    CmsUserQueryBuilder.getGroupUserSubqueryColumns()
  - internalCreateFlagCondition
```
protected java.lang.String internalCreateFlagCondition(java.lang.String col,
                                           int flags)
```
    Helper method for creating a flag condition.
    
    参数:
    col - the column which contains the flags
    flags - the flags to match
    
    返回:
    the flag condition
  - tabGroups
```
protected java.lang.String tabGroups()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Table name accessor.
    
    覆盖:
    
    tabGroups 在类中 CmsUserQueryBuilder
    
    返回:
    the name of a table
    另请参阅:
    CmsUserQueryBuilder.tabGroups()
  - tabGroupUsers
```
protected java.lang.String tabGroupUsers()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Table name accessor.
    
    覆盖:
    
    tabGroupUsers 在类中 CmsUserQueryBuilder
    
    返回:
    the name of a table
    另请参阅:
    CmsUserQueryBuilder.tabGroupUsers()
  - tabUsers
```
protected java.lang.String tabUsers()
```
    从类复制的说明: CmsUserQueryBuilder
    
    Table name accessor.
    
    覆盖:
    
    tabUsers 在类中 CmsUserQueryBuilder
    
    返回:
    the name of a table
    另请参阅:
    CmsUserQueryBuilder.tabUsers()
  - uncompressFlags
```
protected java.util.List<java.lang.Integer> uncompressFlags(int flags)
```
    Uncompresses an integer used to store flags into its component flags.
    
    参数:
    flags - the flags as an integer
    
    返回:
    a list of integers which contain a single flag each

类 CmsJpaUserQueryBuilder

构造器概要

方法概要

从类继承的方法 org.opencms.db.generic.CmsUserQueryBuilder

从类继承的方法 java.lang.Object

构造器详细资料

CmsJpaUserQueryBuilder

方法详细资料

createUserQuery

addSorting

colDateCreated

colEmail

colFirstName

colFlags

colGroupUserGroupId

colGroupUserUserId

colId

colLastLogin

colLastName

colName

colOu

colPassword

createFlagCondition

createSingleFlagCondition

generateConcat

getGroupUserSubqueryColumns

internalCreateFlagCondition

tabGroups

tabGroupUsers

tabUsers

uncompressFlags