public interface ProficiencySearch extends OsidSearch
The search interface for governing proficiency searches.
Modifier and Type | Method and Description |
---|---|
ProficiencySearchRecord |
getProficiencySearchRecord(Type proficiencySearchRecordType)
Gets the proficiency search record corresponding to the given
proficiency search record
Type. |
void |
orderProficiencyResults(ProficiencySearchOrder proficiencySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProficiencies(IdList proficiencyIds)
Execute this search among the given list of proficiencies.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProficiencies(IdList proficiencyIds)
proficiencyIds
- list of proficienciesNullArgumentException
- proficiencyIds
is null
mandatory
- This method must be implemented. void orderProficiencyResults(ProficiencySearchOrder proficiencySearchOrder)
proficiencySearchOrder
- proficiency search orderNullArgumentException
- proficiencySearchOrder
is null
UnsupportedException
- proficiencySearchOrder
is not of this servicemandatory
- This method must be implemented. ProficiencySearchRecord getProficiencySearchRecord(Type proficiencySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.proficiencySearchRecordType
- a proficiency search record typeNullArgumentException
-
proficiencySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(proficiencySearchRecordType)
is
false
mandatory
- This method must be implemented.