Interface ProvisionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProvisionSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProvisionQueryInspector	getProvisionQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProvisionList	getProvisions()	Gets the provision list resulting from a search.
ProvisionSearchResultsRecord	getProvisionSearchResultsRecord(Type provisionSearchRecordType)	Gets the provision search results record corresponding to the given provision 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

getProvisions

ProvisionList getProvisions()

Gets the provision list resulting from a search.

Returns:

the provision list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProvisionQueryInspector

ProvisionQueryInspector getProvisionQueryInspector()

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

Returns:

the provision query inspector

Compliance:

mandatory - This method must be implemented.

getProvisionSearchResultsRecord

ProvisionSearchResultsRecord getProvisionSearchResultsRecord(Type provisionSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

provisionSearchRecordType - a provision search record type

Returns:

the provision search results record

Throws:

NullArgumentException - provisionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.