Interface CanonicalUnitProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CanonicalUnitProcessorSearch
extends OsidSearch

The search interface for governing canonical unit processor searches.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitProcessorSearchRecord	getCanonicalUnitProcessorSearchRecord(Type canonicalUnitProcessorSearchRecordType)	Gets the canonical unit processor search record corresponding to the given canonical unit processor search record Type.
void	orderCanonicalUnitProcessorResults(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongCanonicalUnitProcessors(IdList canonicalUnitProcessorIds)	Execute this search among the given list of canonical unit processors.

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

searchAmongCanonicalUnitProcessors

void searchAmongCanonicalUnitProcessors(IdList canonicalUnitProcessorIds)

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

Parameters:

canonicalUnitProcessorIds - list of canonical unit processors

Throws:

NullArgumentException - canonicalUnitProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitProcessorResults

void orderCanonicalUnitProcessorResults(CanonicalUnitProcessorSearchOrder canonicalUnitProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

canonicalUnitProcessorSearchOrder - canonical unit processor search order

Throws:

NullArgumentException - canonicalUnitProcessorSearchOrder is null

UnsupportedException - canonicalUnitProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorSearchRecord

CanonicalUnitProcessorSearchRecord getCanonicalUnitProcessorSearchRecord(Type canonicalUnitProcessorSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

canonicalUnitProcessorSearchRecordType - a canonical unit processor search record type

Returns:

the canonical unit processor search record

Throws:

NullArgumentException - canonicalUnitProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.