Interface TodoProducerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TodoProducerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
TodoProducerQueryInspector	getTodoProducerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
TodoProducerList	getTodoProducers()	Gets the TodoProducerList resulting from a search.
TodoProducerSearchResultsRecord	getTodoProducerSearchResultsRecord(Type todoProducerSearchRecordType)	Gets the todo producer search results record corresponding to the given todo producer search record Type .This method must be 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

getTodoProducers

TodoProducerList getTodoProducers()

Gets the TodoProducerList resulting from a search.

Returns:

the todo producer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getTodoProducerQueryInspector

TodoProducerQueryInspector getTodoProducerQueryInspector()

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

Returns:

the todo producer query inspector

Compliance:

mandatory - This method must be implemented.

getTodoProducerSearchResultsRecord

TodoProducerSearchResultsRecord getTodoProducerSearchResultsRecord(Type todoProducerSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

todoProducerSearchRecordType - a todo producer search record type

Returns:

the todo producer search results record

Throws:

NullArgumentException - todoProducerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(todoProducerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.