Interface CanonicalUnitEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CanonicalUnitEnablerSearch
extends OsidSearch

The search interface for governing canonical unit enabler searches.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitEnablerSearchRecord	getCanonicalUnitEnablerSearchRecord(Type canonicalUnitEnablerSearchRecordType)	Gets the canonical unit enabler search record corresponding to the given canonical unit enabler search record Type.
void	orderCanonicalUnitEnablerResults(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCanonicalUnitEnablers(IdList canonicalUnitEnablerIds)	Execute this search among the given list of canonical unit enablers.

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

searchAmongCanonicalUnitEnablers

void searchAmongCanonicalUnitEnablers(IdList canonicalUnitEnablerIds)

Execute this search among the given list of canonical unit enablers.

Parameters:

canonicalUnitEnablerIds - list of canonical unit enablers

Throws:

NullArgumentException - canonicalUnitEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitEnablerResults

void orderCanonicalUnitEnablerResults(CanonicalUnitEnablerSearchOrder canonicalUnitEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

canonicalUnitEnablerSearchOrder - canonical unit enabler search order

Throws:

NullArgumentException - canonicalUnitEnablerSearchOrder is null

UnsupportedException - canonicalUnitEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerSearchRecord

CanonicalUnitEnablerSearchRecord getCanonicalUnitEnablerSearchRecord(Type canonicalUnitEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

canonicalUnitEnablerSearchRecordType - a canonical unit enabler search record type

Returns:

the canonical unit enabler search record

Throws:

NullArgumentException - canonicalUnitEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.