Interface | osid.calendaring.CommitmentSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByEvent | ||
Description |
Specified a preference for ordering results by the event. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsEventSearchOrder | ||
Description |
Tests if an | ||
Return | boolean | true if an event search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventSearchOrder | ||
Description |
Gets the search order for an event. | ||
Return | osid.calendaring.EventSearchOrder | the event search order | |
Errors | UNIMPLEMENTED | supportsEventSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsEventSearchOrder()
is true. | |
Method | orderByResource | ||
Description |
Specified a preference for ordering results by the resource. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceSearchOrder | ||
Description |
Gets the search order for a resource. | ||
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 | getCommitmentSearchOrderRecord | ||
Description |
Gets the commitment search order record corresponding
to the given commitment record | ||
Parameters | osid.type.Type | commitmentRecordType | a commitment record type |
Return | osid.calendaring.records.CommitmentSearchOrderRecord | the commitment search order record | |
Errors | NULL_ARGUMENT | commitmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(commitmentRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |