OSID Specifications
offering package
Version 3.0.0
offering package
Version 3.0.0
| Interface | osid.offering.ParticipantSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.offering.ParticipantSearchSession | ||
osid.offering.ParticipantSmartCatalogueSession | |||
osid.offering.ResultSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByOffering | ||
| Description |
Specifies a preference for ordering the result set by the offering. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsOfferingSearchOrder | ||
| Description |
Tests if an offering search order is available. | ||
| Return | boolean | true if an offering search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingSearchOrder | ||
| Description |
Gets the offering search order. | ||
| Return | osid.offering.OfferingSearchOrder | the offering search order | |
| Errors | UNIMPLEMENTED | supportsOfferingSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsOfferingSearchOrder() is true . | |
| Method | orderByResource | ||
| Description |
Specifies a preference for ordering the result set by the resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResourceSearchOrder | ||
| Description |
Tests if a resource search order is available. | ||
| Return | boolean | true if an offering search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceSearchOrder | ||
| Description |
Gets the resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsResourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsResourceSearchOrder() is true . | |
| Method | orderByTimePeriod | ||
| Description |
Specifies a preference for ordering the result set by time period. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsTimePeriodSearchOrder | ||
| Description |
Tests if a time period order is available. | ||
| Return | boolean | true if a time period order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimePeriodSearchOrder | ||
| Description |
Gets the time period order. | ||
| Return | osid.calendaring.TimePeriodSearchOrder | the time period search order | |
| Errors | UNIMPLEMENTED | supportsTimePeriodSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsTimePeriodSearchOrder() is true . | |
| Method | getParticipantSearchOrderRecord | ||
| Description |
Gets the participant search order record corresponding
to the given participant record | ||
| Parameters | osid.type.Type | participantRecordType | a participant record type |
| Return | osid.offering.records.ParticipantSearchOrderRecord | the participant search order record | |
| Errors | NULL_ARGUMENT | participantRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(participantRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |