com.atlassian.confluence.search.v2.lucene.compatibility

Class V2SearchSmartListManager

java.lang.Object

com.atlassian.confluence.search.v2.lucene.compatibility.V2SearchSmartListManager

All Implemented Interfaces:

SmartListManager

public class V2SearchSmartListManager
extends Object
implements SmartListManager

A SmartListManager backed by the V2 Search API, for backwards compatibility.

Constructor Summary

Constructors

Constructor and Description
V2SearchSmartListManager(SearchManager searchManager, ConfluenceIndexManager indexManager)

Method Summary

Modifier and Type	Method and Description
List	getListQueryResults(ListQuery listQuery, boolean loadObjects) Returns a list of those objects in the Confluence system that match the given ListQuery.
String	getStatusMessageKey() The smart list manager implementations are not guarenteed to be able to provide the latest and most up to date information all of the time (eg: during a lucene re-index).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

V2SearchSmartListManager

public V2SearchSmartListManager(SearchManager searchManager,
                                ConfluenceIndexManager indexManager)

Method Detail

getListQueryResults

public List getListQueryResults(ListQuery listQuery,
                                boolean loadObjects)

Description copied from interface: SmartListManager

Returns a list of those objects in the Confluence system that match the given ListQuery.

The loadObjects parameter allows you to trade off speed against the amount of information returned. Passing false to this parameter will give you back a list of SearchResultWithExcerpt objects, containing whatever information about the matching objects can be gathered directly from the Lucene index. This is enough information for most purposes.

If you want a list of the actual hibernate objects from the database, pass true to this parameter, but be aware you're going to pay the cost of 'n' database calls to retrieve those objects.

Specified by:

getListQueryResults in interface SmartListManager

Parameters:

listQuery - the query to perform

loadObjects - pass true to return

Returns:

ContentEntityObjects List if loadObjects true, Map of object attributes otherwise

getStatusMessageKey

public String getStatusMessageKey()

Description copied from interface: SmartListManager

The smart list manager implementations are not guarenteed to be able to provide the latest and most up to date information all of the time (eg: during a lucene re-index). Under such circumstances, the smart list manager will provide access to a human readable status message that can be displayed to the user.

Specified by:

getStatusMessageKey in interface SmartListManager

Returns:

a key to a status message or null if there is no message.