com.atlassian.confluence.core.persistence
Interface SearchableDao

All Known Implementing Classes:

HibernateSearchableDao

public interface SearchableDao

Provides access to Searchable objects. Searchable is a marker interface over persistent classes (and is not in itself persistent).

Method Summary

List<com.atlassian.bonnie.Handle>	findAllSearchableHandles() Deprecated. since 5.2.
List<com.atlassian.bonnie.Handle>	findLatestSearchableHandles() Deprecated. since 5.2. Use getAllSearchablesGroupedByType().
List<List<HibernateHandle>>	getAllSearchablesGroupedByType() Deprecated. since 5.2. Use getLatestSearchableHandlesGroupedByType()
int	getCountOfLatestSearchables() Finds the count of all latest searchables.
int	getCountOfLatestSearchables(Class clazz) Finds the count of the latest searchables that implement the specified hibernate entity class.
List<HibernateHandle>	getLatestSearchableHandles(Class clazz) Finds a list of handles for the specified class.
List<List<HibernateHandle>>	getLatestSearchableHandlesGroupedByType() Returns a list of latest searchable handles grouped by hibernate entity class.
int	getSearchableCount() Deprecated. since 5.2. Use getCountOfLatestSearchables() instead.

Method Detail

getLatestSearchableHandlesGroupedByType

List<List<HibernateHandle>> getLatestSearchableHandlesGroupedByType()

Returns a list of latest searchable handles grouped by hibernate entity class. Each sublist is guaranteed to be one type.

Returns:

a list of latest searchable handles grouped by hibernate entity class. Each sublist is guaranteed to be one type.

Since:

5.2

getLatestSearchableHandles

List<HibernateHandle> getLatestSearchableHandles(Class clazz)

Finds a list of handles for the specified class.

Parameters:

clazz - a hibernate entity class

Since:

5.2

getCountOfLatestSearchables

int getCountOfLatestSearchables()

Finds the count of all latest searchables.

Since:

5.2

getCountOfLatestSearchables

int getCountOfLatestSearchables(Class clazz)

Finds the count of the latest searchables that implement the specified hibernate entity class.

Parameters:

clazz - a hibernate entity class

Since:

5.2

getAllSearchablesGroupedByType

List<List<HibernateHandle>> getAllSearchablesGroupedByType()

Deprecated. since 5.2. Use getLatestSearchableHandlesGroupedByType()

Returns a grouped list of all searchables available. Each list is guaranteed to only contain one type of handles.

Returns:

a list of lists of handles. Grouped by handle type.

Since:

4.1

findAllSearchableHandles

List<com.atlassian.bonnie.Handle> findAllSearchableHandles()

Deprecated. since 5.2.

Gets handles for all Searchable objects.

Returns:

a List of Handles.

findLatestSearchableHandles

List<com.atlassian.bonnie.Handle> findLatestSearchableHandles()

Deprecated. since 5.2. Use getAllSearchablesGroupedByType().

Gets a handle for (@link Searchable} objects, only returning the latest version of objects that implement Versioned.

Returns:

a List of Handles

getSearchableCount

int getSearchableCount()

Deprecated. since 5.2. Use getCountOfLatestSearchables() instead.

Gets the total number of Searchables.

Returns:

the total number of Searchables.