Interface | osid.course.chronicle.AwardEntrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing award entry searches. | ||
Method | searchAmongAwardEntries | ||
Description |
Execute this search among the given list of award entries. | ||
Parameters | osid.id.IdList | awardEntryIds | list of award entry Ids |
Errors | NULL_ARGUMENT | awardEntryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAwardEntryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.chronicle.AwardEntrySearchOrder | awardEntrySearchOrder | award entry search order |
Errors | NULL_ARGUMENT | awardEntrySearchOrder is null | |
UNSUPPORTED | awardEntrySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntrySearchRecord | ||
Description |
Gets the award entry search record corresponding to the
given award entry search record | ||
Parameters | osid.type.Type | awardEntrySearchRecordType | an award entry search record type |
Return | osid.course.chronicle.records.AwardEntrySearchRecord | the award entry search record | |
Errors | NULL_ARGUMENT | awardEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(awardEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |