Package com.redwood.scheduler.api.search
Interface SearchResultSet
-
public interface SearchResultSet
A search result set. The search results are initially positioned before the first result. Callnext()
to see if there is a next result. The SearchResultSet is instantiated via search methods, for example JobFile.search().
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SearchResult
getSearchResult()
Get the search result.boolean
next()
Attempt to advance to the next result.
-
-
-
Method Detail
-
next
boolean next() throws com.redwood.scheduler.api.exception.JobFileTransientException, com.redwood.scheduler.api.exception.JobFileException
Attempt to advance to the next result.- Returns:
- true if there was a next result, false otherwise.
- Throws:
com.redwood.scheduler.api.exception.JobFileException
- permanent error, cannot be recovered.com.redwood.scheduler.api.exception.JobFileTransientException
- transient error, retry may work.
-
getSearchResult
SearchResult getSearchResult()
Get the search result.- Returns:
- the result.
-
-