| Interface | osid.resourcing.CommissionSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| 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 | orderByWork | ||
| Description | 
                     Orders the results by work.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkSearchOrder | ||
| Description | 
                     Tests if a work search order is available.  | ||
| Return | boolean |  true  if a work search order is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkSearchOrder | ||
| Description | 
                     Gets the work search order.  | ||
| Return | osid.resourcing.WorkSearchOrder | the work search order | |
| Errors | ILLEGAL_STATE |  supportsWorkSearchOrder()  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 | getCommissionSearchOrderRecord | ||
| Description | 
                     Gets the commission search order record corresponding 
                    to the given commission record   | ||
| Parameters | osid.type.Type | commissionRecordType | a commission record type | 
| Return | osid.resourcing.records.CommissionSearchOrderRecord | the commission search order record | |
| Errors | NULL_ARGUMENT |  commissionRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(commissionRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |