jakarta.nosql.mapping.document

Interface DocumentQueryMapper.DocumentMapperWhere

All Superinterfaces:

DocumentQueryMapper.DocumentMapperQueryBuild

Enclosing interface:

DocumentQueryMapper

public static interface DocumentQueryMapper.DocumentMapperWhere
extends DocumentQueryMapper.DocumentMapperQueryBuild

The Document Where whose define the condition in the query.

Method Summary

Modifier and Type	Method and Description
DocumentQueryMapper.DocumentMapperNameCondition	and(String name) Starts a new condition in the select using DocumentCondition.and(jakarta.nosql.document.DocumentCondition)
DocumentQueryMapper.DocumentMapperLimit	limit(long limit) Defines the maximum number of results to retrieve.
DocumentQueryMapper.DocumentMapperNameCondition	or(String name) Appends a new condition in the select using DocumentCondition.or(jakarta.nosql.document.DocumentCondition)
DocumentQueryMapper.DocumentMapperOrder	orderBy(String name) Add the order how the result will returned
DocumentQueryMapper.DocumentMapperSkip	skip(long skip) Defines the position of the first result to retrieve.

Methods inherited from interface jakarta.nosql.mapping.document.DocumentQueryMapper.DocumentMapperQueryBuild

build, build, getResult, getResult, getResult, getSingleResult, getSingleResult, getSingleResult, page

Method Detail

and

DocumentQueryMapper.DocumentMapperNameCondition and(String name)

Starts a new condition in the select using DocumentCondition.and(jakarta.nosql.document.DocumentCondition)

Parameters:

name - a condition to be added

Returns:

the same DocumentQueryMapper.DocumentMapperNameCondition with the condition appended

Throws:

NullPointerException - when condition is null

or

DocumentQueryMapper.DocumentMapperNameCondition or(String name)

Appends a new condition in the select using DocumentCondition.or(jakarta.nosql.document.DocumentCondition)

Parameters:

name - a condition to be added

Returns:

the same DocumentQueryMapper.DocumentMapperNameCondition with the condition appended

Throws:

NullPointerException - when condition is null

skip

DocumentQueryMapper.DocumentMapperSkip skip(long skip)

Defines the position of the first result to retrieve.

Parameters:

skip - the first result to retrive

Returns:

a query with first result defined

limit

DocumentQueryMapper.DocumentMapperLimit limit(long limit)

Defines the maximum number of results to retrieve.

Parameters:

limit - the limit

Returns:

a query with the limit defined

orderBy

DocumentQueryMapper.DocumentMapperOrder orderBy(String name)

Add the order how the result will returned

Parameters:

name - the order

Returns:

a query with the sort defined

Throws:

NullPointerException - when name is null