Interface ProficiencySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProficiencySearch
extends OsidSearch

The search interface for governing proficiency searches.

Method Summary

Modifier and Type	Method	Description
ProficiencySearchRecord	getProficiencySearchRecord(Type proficiencySearchRecordType)	Gets the proficiency search record corresponding to the given proficiency search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProficiencyResults(ProficiencySearchOrder proficiencySearchOrder)	Specify an ordering to the search results.
void	searchAmongProficiencies(IdList proficiencyIds)	Execute this search among the given list of proficiencies.

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

searchAmongProficiencies

void searchAmongProficiencies(IdList proficiencyIds)

Execute this search among the given list of proficiencies.

Parameters:

proficiencyIds - list of proficiencies

Throws:

NullArgumentException - proficiencyIds is null

Compliance:

mandatory - This method must be implemented.

orderProficiencyResults

void orderProficiencyResults(ProficiencySearchOrder proficiencySearchOrder)

Specify an ordering to the search results.

Parameters:

proficiencySearchOrder - proficiency search order

Throws:

NullArgumentException - proficiencySearchOrder is null

UnsupportedException - proficiencySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProficiencySearchRecord

ProficiencySearchRecord getProficiencySearchRecord(Type proficiencySearchRecordType)
                                            throws OperationFailedException

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

Parameters:

proficiencySearchRecordType - a proficiency search record type

Returns:

the proficiency search record

Throws:

NullArgumentException - proficiencySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(proficiencySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.