Package org.apache.syncope.core.persistence.api.dao

Interface AnySearchDAO

All Superinterfaces:

DAO<Any<?>>

All Known Implementing Classes:

AbstractAnySearchDAO, ElasticsearchAnySearchDAO, JPAAnySearchDAO, MaJPAJSONAnySearchDAO, MyJPAJSONAnySearchDAO, OJPAJSONAnySearchDAO, OpenSearchAnySearchDAO, PGJPAJSONAnySearchDAO

public interface AnySearchDAO
extends DAO<Any<?>>

Method Summary

Modifier and Type	Method	Description
int	count(Realm base, boolean recursive, Set<String> adminRealms, SearchCond searchCondition, AnyTypeKind kind)
<T extends Any<?>> List<T>	search(SearchCond searchCondition, List<OrderByClause> orderBy, AnyTypeKind kind)
<T extends Any<?>> List<T>	search(SearchCond searchCondition, AnyTypeKind kind)
<T extends Any<?>> List<T>	search(Realm base, boolean recursive, Set<String> adminRealms, SearchCond searchCondition, int page, int itemsPerPage, List<OrderByClause> orderBy, AnyTypeKind kind)

Methods inherited from interface org.apache.syncope.core.persistence.api.dao.DAO

detach, refresh

Method Detail

count

int count(Realm base,
          boolean recursive,
          Set<String> adminRealms,
          SearchCond searchCondition,
          AnyTypeKind kind)

Parameters:

base - Realm to start searching from

recursive - whether search should recursively include results from child Realms

adminRealms - realms for which the caller owns the proper entitlement(s)

searchCondition - the search condition

kind - any object

Returns:

size of search result

search

<T extends Any<?>> List<T> search(SearchCond searchCondition,
                                  AnyTypeKind kind)

Type Parameters:

T - any

Parameters:

searchCondition - the search condition

kind - any object

Returns:

the list of any objects matching the given search condition

search

<T extends Any<?>> List<T> search(SearchCond searchCondition,
                                  List<OrderByClause> orderBy,
                                  AnyTypeKind kind)

Type Parameters:

T - any

Parameters:

searchCondition - the search condition

orderBy - list of ordering clauses

kind - any object

Returns:

the list of any objects matching the given search condition

search

<T extends Any<?>> List<T> search(Realm base,
                                  boolean recursive,
                                  Set<String> adminRealms,
                                  SearchCond searchCondition,
                                  int page,
                                  int itemsPerPage,
                                  List<OrderByClause> orderBy,
                                  AnyTypeKind kind)

Type Parameters:

T - any

Parameters:

base - Realm to start searching from

recursive - whether search should recursively include results from child Realms

adminRealms - realms for which the caller owns the proper entitlement(s)

searchCondition - the search condition

page - position of the first result, start from 1

itemsPerPage - number of results per page

orderBy - list of ordering clauses

kind - any object

Returns:

the list of any objects matching the given search condition (in the given page)