OSID Specifications
resourcing package
Version 3.1.0
resourcing package
Version 3.1.0
| Interface | osid.resourcing.AvailabilitySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.resourcing.AvailabilitySearchSession | ||
osid.resourcing.AvailabilitySmartFoundrySession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByResource | ||
| Description |
Orders the results by 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 a resource 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 | ILLEGAL_STATE | supportsResourceSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByJob | ||
| Description |
Orders the results by job. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsJobSearchOrder | ||
| Description |
Tests if a job search order is available. | ||
| Return | boolean | true if a job search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJobSearchOrder | ||
| Description |
Gets the job search order. | ||
| Return | osid.resourcing.JobSearchOrder | the job search order | |
| Errors | ILLEGAL_STATE | supportsJobSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCompetency | ||
| Description |
Orders the results by competency. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCompetencySearchOrder | ||
| Description |
Tests if a competency search order is available. | ||
| Return | boolean | true if a competency search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompetencySearchOrder | ||
| Description |
Gets the competency search order. | ||
| Return | osid.resourcing.CompetencySearchOrder | the competency search order | |
| Errors | ILLEGAL_STATE | supportsCompetencySearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPercentage | ||
| Description |
Orders the results by percentage availability. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAvailabilitySearchOrderRecord | ||
| Description |
Gets the availability search order record
corresponding to the given availability record
| ||
| Parameters | osid.type.Type | availabilityRecordType | an availability record type |
| Return | osid.resourcing.records.AvailabilitySearchOrderRecord | the availability order record | |
| Errors | NULL_ARGUMENT | availabilityRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(availabilityRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |