Interface ResourceSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ResourceSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ResourceQueryInspector	getResourceQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ResourceList	getResources()	Gets the resource list resulting from a search.
ResourceSearchResultsRecord	getResourceSearchResultsRecord(Type resourceSearchRecordType)	Gets the resource search results record corresponding to the given resource 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

getResources

ResourceList getResources()

Gets the resource list resulting from a search.

Returns:

the resource list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getResourceQueryInspector

ResourceQueryInspector getResourceQueryInspector()

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

Returns:

the resource query inspector

Compliance:

mandatory - This method must be implemented.

getResourceSearchResultsRecord

ResourceSearchResultsRecord getResourceSearchResultsRecord(Type resourceSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

resourceSearchRecordType - a resource search record type

Returns:

the resource search results record

Throws:

NullArgumentException - resourceSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(resourceSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.