Interface CanonicalUnitProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CanonicalUnitProcessorEnablerSearch
extends OsidSearch

The search interface for governing canonical unit processor enabler searches.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitProcessorEnablerSearchRecord	getCanonicalUnitProcessorEnablerSearchRecord(Type canonicalUnitProcessorEnablerSearchRecordType)	Gets the canonical unit processor enabler search record corresponding to the given canonical unit processor enabler search record Type.
void	orderCanonicalUnitProcessorEnablerResults(CanonicalUnitProcessorEnablerSearchOrder canonicalUnitProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCanonicalUnitProcessorEnablers(IdList canonicalUnitProcessorEnablerIds)	Execute this search among the given list of canonical unit processor 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

searchAmongCanonicalUnitProcessorEnablers

void searchAmongCanonicalUnitProcessorEnablers(IdList canonicalUnitProcessorEnablerIds)

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

Parameters:

canonicalUnitProcessorEnablerIds - list of canonical unit processor enablers

Throws:

NullArgumentException - canonicalUnitProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitProcessorEnablerResults

void orderCanonicalUnitProcessorEnablerResults(CanonicalUnitProcessorEnablerSearchOrder canonicalUnitProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

canonicalUnitProcessorEnablerSearchOrder - canonical unit processor enabler search order

Throws:

NullArgumentException - canonicalUnitProcessorEnablerSearchOrder is null

UnsupportedException - canonicalUnitProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorEnablerSearchRecord

CanonicalUnitProcessorEnablerSearchRecord getCanonicalUnitProcessorEnablerSearchRecord(Type canonicalUnitProcessorEnablerSearchRecordType)
                                                                                throws OperationFailedException

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

Parameters:

canonicalUnitProcessorEnablerSearchRecordType - a canonical unit processor enabler search record type

Returns:

the canonical unit processor enabler search record

Throws:

NullArgumentException - canonicalUnitProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.