Interface | osid.recognition.ConferralSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing conferral searches. | ||
Method | searchAmongConferrals | ||
Description |
Execute this search among the given list of conferrals. | ||
Parameters | osid.id.IdList | conferralIds | list of conferrals |
Errors | NULL_ARGUMENT | conferralIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderConferralResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.recognition.ConferralSearchOrder | conferralSearchOrder | conferral search order |
Errors | NULL_ARGUMENT | conferralSearchOrder is null | |
UNSUPPORTED | conferralSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConferralSearchRecord | ||
Description |
Gets the conferral search record corresponding to the
given conferral search record | ||
Parameters | osid.type.Type | conferralSearchRecordType | a conferral search record type |
Return | osid.recognition.records.ConferralSearchRecord | the conferral search record | |
Errors | NULL_ARGUMENT | conferralSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(conferralSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |