Interface ObjectiveBankSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ObjectiveBankSearch
extends OsidSearch

The interface for governing objective bank searches.

Method Summary

Modifier and Type	Method	Description
ObjectiveBankSearchRecord	getObjectiveBankSearchRecord(Type objectiveBankSearchRecordType)	Gets the objective bank search record corresponding to the given objective bank search record Type .This method is used to retrieve an object implementing the requested record.
void	orderObjectiveBankResults(ObjectiveBankSearchOrder objectiveBankSearchOrder)	Specify an ordering to the search results.
void	searchAmongObjectiveBanks(IdList objectiveBankIds)	Execute this search among the given list of objective banks.

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

searchAmongObjectiveBanks

void searchAmongObjectiveBanks(IdList objectiveBankIds)

Execute this search among the given list of objective banks.

Parameters:

objectiveBankIds - list of objective banks

Throws:

NullArgumentException - objective bankIds is null

Compliance:

mandatory - This method must be implemented.

orderObjectiveBankResults

void orderObjectiveBankResults(ObjectiveBankSearchOrder objectiveBankSearchOrder)

Specify an ordering to the search results.

Parameters:

objectiveBankSearchOrder - objective bank search order

Throws:

NullArgumentException - objectiveBankSearchOrder is null

UnsupportedException - objectiveBankSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getObjectiveBankSearchRecord

ObjectiveBankSearchRecord getObjectiveBankSearchRecord(Type objectiveBankSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

objectiveBankSearchRecordType - an objective bank search record type

Returns:

the objective bank search record

Throws:

NullArgumentException - objectiveBankSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasSearchRecordType(objective bankSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.