Interface CompositionEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CompositionEnablerSearch
extends OsidSearch

The search interface for governing composition enabler searches.

Method Summary

Modifier and Type	Method	Description
CompositionEnablerSearchRecord	getCompositionEnablerSearchRecord(Type compositionEnablerSearchRecordType)	Gets the composition enabler search record corresponding to the given composition enabler search record Type.
void	orderCompositionEnablerResults(CompositionEnablerSearchOrder compositionEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCompositionEnablers(IdList compositionEnablerIds)	Execute this search among the given list of composition 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

searchAmongCompositionEnablers

void searchAmongCompositionEnablers(IdList compositionEnablerIds)

Execute this search among the given list of composition enablers.

Parameters:

compositionEnablerIds - list of composition enablers

Throws:

NullArgumentException - compositionEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderCompositionEnablerResults

void orderCompositionEnablerResults(CompositionEnablerSearchOrder compositionEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

compositionEnablerSearchOrder - composition enabler search order

Throws:

NullArgumentException - compositionEnablerSearchOrder is null

UnsupportedException - compositionEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerSearchRecord

CompositionEnablerSearchRecord getCompositionEnablerSearchRecord(Type compositionEnablerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

compositionEnablerSearchRecordType - a composition enabler search record type

Returns:

the composition enabler search record

Throws:

NullArgumentException - compositionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.