OSID Specifications
recognition package
Version 3.1.0
recognition package
Version 3.1.0
| Interface | osid.recognition.ConferralSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.recognition.ConferralSearchSession | ||
osid.recognition.ConferralSmartAcademySession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAward | ||
| Description |
Specifies a preference for ordering the result set by the award. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAwardSearchOrder | ||
| Description |
Tests if an award order is available. | ||
| Return | boolean | true if an award order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardSearchOrder | ||
| Description |
Gets the award order. | ||
| Return | osid.recognition.AwardSearchOrder | the award search order | |
| Errors | UNIMPLEMENTED | supportsAwardSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsAwardSearchOrder()
is true. | |
| Method | orderByRecipient | ||
| Description |
Specifies a preference for ordering the result set by the recipient. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsRecipientSearchOrder | ||
| Description |
Tests if a recipient order is available. | ||
| Return | boolean | true if a resource search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipientSearchOrder | ||
| Description |
Gets the recipient order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsRecipientSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsRecipientSearchOrder() is true. | |
| Method | orderByReference | ||
| Description |
Specifies a preference for ordering the result set by the reference. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByConvocation | ||
| Description |
Specifies a preference for ordering the result set by the convocation. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsConvocationSearchOrder | ||
| Description |
Tests if a convocation order is available. | ||
| Return | boolean | true if a convocation order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConvocationSearchOrder | ||
| Description |
Gets the convocation order. | ||
| Return | osid.recognition.ConvocationSearchOrder | the convocation search order | |
| Errors | UNIMPLEMENTED | supportsConvocationSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsConvocationSearchOrder() is true. | |
| Method | getConferralSearchOrderRecord | ||
| Description |
Gets the conferral search order record corresponding
to the given conferral record | ||
| Parameters | osid.type.Type | conferralRecordType | a conferral record type |
| Return | osid.recognition.records.ConferralSearchOrderRecord | the conferral search order record | |
| Errors | NULL_ARGUMENT | conferralRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(conferralRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |