Interface ProvisionableSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProvisionableSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProvisionableQueryInspector	getProvisionableQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProvisionableList	getProvisionables()	Gets the provisionable list resulting from a search.
ProvisionableSearchResultsRecord	getProvisionableSearchResultsRecord(Type provisionableSearchRecordType)	Gets the provisionable search results record corresponding to the given provisionable 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

getProvisionables

ProvisionableList getProvisionables()

Gets the provisionable list resulting from a search.

Returns:

the provisionable list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProvisionableQueryInspector

ProvisionableQueryInspector getProvisionableQueryInspector()

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

Returns:

the provisionable query inspector

Compliance:

mandatory - This method must be implemented.

getProvisionableSearchResultsRecord

ProvisionableSearchResultsRecord getProvisionableSearchResultsRecord(Type provisionableSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

provisionableSearchRecordType - a provisionable search record type

Returns:

the provisionable search results record

Throws:

NullArgumentException - provisionableSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.