org.alfresco.repo.webservice

Interface QuerySession<RESULTSET>

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractQuerySession, RepositoryQuerySession, UserQuerySession

public interface QuerySession<RESULTSET>
extends Serializable

An interface for objects that track the query and its results. The only commonality between the different types of results used in the WebServices return values is that they are Serializable.

Author:

Derek Hulley

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Retrieves the id this query session can be identified as
RESULTSET	getNextResults(ServiceRegistry serviceRegistry) Get the next batch of results from the full set of available results.
boolean	haveMoreResults() Check if the session is expecting more results.

Method Detail

getId

String getId()

Retrieves the id this query session can be identified as

Returns:

Id of this query session

haveMoreResults

boolean haveMoreResults()

Check if the session is expecting more results. This will be false if the cursor previously passed the end of a given set of results.

getNextResults

RESULTSET getNextResults(ServiceRegistry serviceRegistry)

Get the next batch of results from the full set of available results. If there are no results available, then this session must go and fetch them. It is up to the implementation to provide a means for this to occur.

Parameters:

serviceRegistry - the services to perform a query

allResults - All available results. It may be necessary to requery to get the results.

Returns:

Returns the next batch of results based on the maximum fetch size. If there are no more results, the resultset will be empty.