Interface InstallationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InstallationSearch
extends OsidSearch

InstallationSearch defines the interface for specifying installation search options.

Method Summary

Modifier and Type	Method	Description
InstallationSearchRecord	getInstallationSearchRecord(Type installationSearchRecordType)	Gets the installation search record corresponding to the given installation search record Type .This method is used to retrieve an object implementing the requested record.
void	orderInstallationResults(InstallationSearchOrder installationSearchOrder)	Specify an ordering to the search results.
void	searchAmongInstallations(IdList installationIds)	Execute this search among the given list of installations.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongInstallations

void searchAmongInstallations(IdList installationIds)

Execute this search among the given list of installations.

Parameters:

installationIds - list of installations

Throws:

NullArgumentException - installationIds is null

Compliance:

mandatory - This method must be implemented.

orderInstallationResults

void orderInstallationResults(InstallationSearchOrder installationSearchOrder)

Specify an ordering to the search results.

Parameters:

installationSearchOrder - installation search order

Throws:

NullArgumentException - installationSearchOrder is null

UnsupportedException - installationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInstallationSearchRecord

InstallationSearchRecord getInstallationSearchRecord(Type installationSearchRecordType)
                                              throws OperationFailedException

Gets the installation search 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 record

Throws:

NullArgumentException - installationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(installationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.