Interface CanonicalUnitSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CanonicalUnitSearch
extends OsidSearch

The search interface for governing canonical unit searches.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitSearchRecord	getCanonicalUnitSearchRecord(Type canonicalUnitSearchRecordType)	Gets the record corresponding to the given canonical unit search record Type.
void	orderCanonicalUnitResults(CanonicalUnitSearchOrder canonicalUnitSearchOrder)	Specify an ordering to the search results.
void	searchAmongCanonicalUnits(IdList canonicalUnitIds)	Execute this search among the given list of canonical units.

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

searchAmongCanonicalUnits

void searchAmongCanonicalUnits(IdList canonicalUnitIds)

Execute this search among the given list of canonical units.

Parameters:

canonicalUnitIds - list of canonical units

Throws:

NullArgumentException - canonicalUnitIds is null

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitResults

void orderCanonicalUnitResults(CanonicalUnitSearchOrder canonicalUnitSearchOrder)

Specify an ordering to the search results.

Parameters:

canonicalUnitSearchOrder - canonical unit search order

Throws:

NullArgumentException - canonicalUnitSearchOrder is null

UnsupportedException - canonicalUnitSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitSearchRecord

CanonicalUnitSearchRecord getCanonicalUnitSearchRecord(Type canonicalUnitSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

canonicalUnitSearchRecordType - a canonical unit search record type

Returns:

the canonical unit search record

Throws:

NullArgumentException - canonicalUnitSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.