Interface | osid.recognition.ConvocationSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing convocation searches. | ||
Method | searchAmongConvocations | ||
Description |
Execute this search among the given list of convocations. | ||
Parameters | osid.id.IdList | convocationIds | list of convocations |
Errors | NULL_ARGUMENT | convocationIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderConvocationResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.recognition.ConvocationSearchOrder | convocationSearchOrder | convocation search order |
Errors | NULL_ARGUMENT | convocationSearchOrder is null | |
UNSUPPORTED | convocationSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationSearchRecord | ||
Description |
Gets the convocation search record corresponding to the
given convocation search record | ||
Parameters | osid.type.Type | convocationSearchRecordType | a convocation search record type |
Return | osid.recognition.records.ConvocationSearchRecord | the convocation search record | |
Errors | NULL_ARGUMENT | convocationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(convocationSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |