Interface | osid.recognition.AcademySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing academy searches. | ||
Method | searchAmongAcademies | ||
Description |
Execute this search among the given list of academies. | ||
Parameters | osid.id.IdList | academyIds | list of academies |
Errors | NULL_ARGUMENT | academyIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAcademyResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.recognition.AcademySearchOrder | academysearchOrder | academy search order |
Errors | NULL_ARGUMENT | academysearchOrder is null | |
UNSUPPORTED | academysearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademySearchRecord | ||
Description |
Gets the academy search record corresponding to the
given academy search record | ||
Parameters | osid.type.Type | academySearchRecordType | an academy search record type |
Return | osid.recognition.records.AcademySearchRecord | the academy search record | |
Errors | NULL_ARGUMENT | academysearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(academysearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |