Interface InstallationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InstallationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
InstallationQueryInspector	getInstallationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
InstallationList	getInstallations()	Gets the installation list resulting from the search.
InstallationSearchResultsRecord	getInstallationSearchResultsRecord(Type installationSearchRecordType)	Gets the installation search results record corresponding to the given installation 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

getInstallations

InstallationList getInstallations()

Gets the installation list resulting from the search.

Returns:

the installation list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getInstallationQueryInspector

InstallationQueryInspector getInstallationQueryInspector()

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

Returns:

the installation query inspector

Compliance:

mandatory - This method must be implemented.

getInstallationSearchResultsRecord

InstallationSearchResultsRecord getInstallationSearchResultsRecord(Type installationSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

installationSearchRecordType - an installation search record type

Returns:

the installation search results record

Throws:

NullArgumentException - installationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(installationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.