Interface RequisiteSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RequisiteSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RequisiteQueryInspector	getRequisiteQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RequisiteList	getRequisites()	Gets the requisite list resulting from a search.
RequisiteSearchResultsRecord	getRequisiteSearchResultsRecord(Type requisiteSearchRecordType)	Gets the requisite search results record corresponding to the given requisite 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

getRequisites

RequisiteList getRequisites()

Gets the requisite list resulting from a search.

Returns:

the requisite list

Throws:

IllegalStateException - the requisite list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRequisiteQueryInspector

RequisiteQueryInspector getRequisiteQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getRequisiteSearchResultsRecord

RequisiteSearchResultsRecord getRequisiteSearchResultsRecord(Type requisiteSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

requisiteSearchRecordType - a requisite search record type

Returns:

the requisite search results record

Throws:

NullArgumentException - requisiteSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requisiteSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.