| Interface | osid.financials.ActivitySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidFederateableSearchOrder | |||
osid.OsidTemporalSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByOrganization | ||
| Description |
Specifies a preference for ordering the result set by the organization. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsOrganizationSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a resource search order is available, false
otherwise | |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrganizationSearchOrder | ||
| Description |
Gets the resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsOrganizationSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsOrganizationSearchOrder()
is true. | |
| Method | orderBySupervisor | ||
| Description |
Specifies a preference for ordering the result set by the supervisor. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSupervisorSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a resource search order is available, false
otherwise | |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupervisorSearchOrder | ||
| Description |
Gets the resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsSupervisorSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsSupervisorSearchOrder()
is true. | |
| Method | orderByCode | ||
| Description |
Specifies a preference for ordering the result set by the code. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivitySearchOrderRecord | ||
| Description |
Gets the activity search order record corresponding to
the given activity record | ||
| Parameters | osid.type.Type | activityRecordType | an activity record type |
| Return | osid.financials.records.ActivitySearchOrderRecord | the activity search order record | |
| Errors | NULL_ARGUMENT | activityRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |