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() Gets handles for all Searchable objects.
List<com.atlassian.bonnie.Searchable>	findAllSearchables() Deprecated. since 3.0. use @{link #findAllSearchableHandles()} instead.
Iterator<com.atlassian.bonnie.Searchable>	findAllSearchablesIterator() Deprecated. since 3.5. use findAllSearchableHandles(), it will keep the session tidier.
List<com.atlassian.bonnie.Handle>	findLatestSearchableHandles() Gets a handle for (@link Searchable} objects, only returning the latest version of objects that implement Versioned.
List<List<HibernateHandle>>	getAllSearchablesGroupedByType() Returns a grouped list of all searchables available.
int	getSearchableCount() Gets the total number of Searchables.

Method Detail

findAllSearchableHandles

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

Gets handles for all Searchable objects.

Returns:

a List of Handles.

findLatestSearchableHandles

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

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

Returns:

a List of Handles

findAllSearchablesIterator

@Deprecated
Iterator<com.atlassian.bonnie.Searchable> findAllSearchablesIterator()

Deprecated. since 3.5. use findAllSearchableHandles(), it will keep the session tidier.

Gets an iterator of all Searchable objects. Use this instead of findAllSearchables()

Returns:

an iterator of all Searchable objects.

findAllSearchables

@Deprecated
List<com.atlassian.bonnie.Searchable> findAllSearchables()

Deprecated. since 3.0. use @{link #findAllSearchableHandles()} instead.

getSearchableCount

int getSearchableCount()

Gets the total number of Searchables.

Returns:

the total number of Searchables.

getAllSearchablesGroupedByType

List<List<HibernateHandle>> getAllSearchablesGroupedByType()

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