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

Modifier and Type	Method	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 .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

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.