Interface CompositionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CompositionSearch
extends OsidSearch

The interface for governing composition searches.

Method Summary

Modifier and Type	Method	Description
CompositionSearchRecord	getCompositionSearchRecord(Type compositionSearchRecordType)	Gets the composition search record corresponding to the given composition search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCompositionResults(CompositionSearchOrder compositionSearchOrder)	Specify an ordering to the search results.
void	searchAmongCompositions(IdList compositionIds)	Execute this search among the given list of compositions.

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

searchAmongCompositions

void searchAmongCompositions(IdList compositionIds)

Execute this search among the given list of compositions.

Parameters:

compositionIds - list of compositions

Throws:

NullArgumentException - compositionIds is null

Compliance:

mandatory - This method must be implemented.

orderCompositionResults

void orderCompositionResults(CompositionSearchOrder compositionSearchOrder)

Specify an ordering to the search results.

Parameters:

compositionSearchOrder - composition search order

Throws:

NullArgumentException - compositionSearchOrder is null

UnsupportedException - compositionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCompositionSearchRecord

CompositionSearchRecord getCompositionSearchRecord(Type compositionSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

compositionSearchRecordType - a composition search record type

Returns:

the composition search record

Throws:

NullArgumentException - compositionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.