Interface TodoSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TodoSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
TodoQueryInspector	getTodoQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
TodoList	getTodos()	Gets the todo list resulting from a search.
TodoSearchResultsRecord	getTodoSearchResultsRecord(Type todoSearchRecordType)	Gets the todo search results record corresponding to the given todo search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getTodos

TodoList getTodos()

Gets the todo list resulting from a search.

Returns:

the todo list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getTodoQueryInspector

TodoQueryInspector getTodoQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getTodoSearchResultsRecord

TodoSearchResultsRecord getTodoSearchResultsRecord(Type todoSearchRecordType)
                                            throws OperationFailedException

Gets the todo search results record corresponding to the given todo search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

todoSearchRecordType - a todo search record type

Returns:

the todo search results record

Throws:

NullArgumentException - todoSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.