org.osid.provisioning

Interface RequestSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RequestSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
RequestQueryInspector	getRequestQueryInspector() Gets the inspector for the query to examine the terms used in the search.
RequestList	getRequests() Gets the request list resulting from a search.
RequestSearchResultsRecord	getRequestSearchResultsRecord(Type requestSearchRecordType) Gets the request search results record corresponding to the given request search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getRequests

RequestList getRequests()

Gets the request list resulting from a search.

Returns:

the request list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRequestQueryInspector

RequestQueryInspector getRequestQueryInspector()

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

Returns:

the request query inspector

Compliance:

mandatory - This method must be implemented.

getRequestSearchResultsRecord

RequestSearchResultsRecord getRequestSearchResultsRecord(Type requestSearchRecordType)
                                                         throws OperationFailedException

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

Parameters:

requestSearchRecordType - a request search record type

Returns:

the request search results record

Throws:

NullArgumentException - requestSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.