Interface EffortSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EffortSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
EffortQueryInspector	getEffortQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
EffortList	getEfforts()	Gets the effort list resulting from a search.
EffortSearchResultsRecord	getEffortSearchResultsRecord(Type effortSearchRecordType)	Gets the effort search results record corresponding to the given effort 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

getEfforts

EffortList getEfforts()

Gets the effort list resulting from a search.

Returns:

the effort list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getEffortQueryInspector

EffortQueryInspector getEffortQueryInspector()

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

Returns:

the effort query inspector

Compliance:

mandatory - This method must be implemented.

getEffortSearchResultsRecord

EffortSearchResultsRecord getEffortSearchResultsRecord(Type effortSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

effortSearchRecordType - an effort search record type

Returns:

the effort search results record

Throws:

NullArgumentException - effortSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(effortSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.