org.osid.control

Interface SystemSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SystemSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
SystemQueryInspector	getSystemQueryInspector() Gets the inspector for the query to examine the terms used in the search.
SystemList	getSystems() Gets the system list resulting from a search.
SystemSearchResultsRecord	getSystemSearchResultsRecord(Type systemSearchRecordType) Gets the system search results record corresponding to the given system 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

getSystems

SystemList getSystems()

Gets the system list resulting from a search.

Returns:

the system list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSystemQueryInspector

SystemQueryInspector getSystemQueryInspector()

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

Returns:

the system query inspector

Compliance:

mandatory - This method must be implemented.

getSystemSearchResultsRecord

SystemSearchResultsRecord getSystemSearchResultsRecord(Type systemSearchRecordType)
                                                       throws OperationFailedException

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

Parameters:

systemSearchRecordType - a system search record type

Returns:

the system search results record

Throws:

NullArgumentException - systemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(systemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.