Interface SystemSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SystemSearch
extends OsidSearch

The search interface for governing system searches.

Method Summary

Modifier and Type	Method	Description
SystemSearchRecord	getSystemSearchRecord(Type systemSearchRecordType)	Gets the system search record corresponding to the given system search record Type.
void	orderSystemResults(SystemSearchOrder systemSearchOrder)	Specify an ordering to the search results.
void	searchAmongSystems(IdList systemIds)	Execute this search among the given list of systems.

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

searchAmongSystems

void searchAmongSystems(IdList systemIds)

Execute this search among the given list of systems.

Parameters:

systemIds - list of systems

Throws:

NullArgumentException - systemIds is null

Compliance:

mandatory - This method must be implemented.

orderSystemResults

void orderSystemResults(SystemSearchOrder systemSearchOrder)

Specify an ordering to the search results.

Parameters:

systemSearchOrder - system search order

Throws:

NullArgumentException - systemSearchOrder is null

UnsupportedException - systemSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSystemSearchRecord

SystemSearchRecord getSystemSearchRecord(Type systemSearchRecordType)
                                  throws OperationFailedException

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

Throws:

NullArgumentException - systemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(systemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.