Interface | osid.resourcing.WorkSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByJob | ||
Description |
Orders the results by the 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 | orderByCreatedDate | ||
Description |
Orders the results by the created date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCompletionDate | ||
Description |
Orders the results by the completion date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorkSearchOrderRecord | ||
Description |
Gets the work search order record corresponding to the
given work record | ||
Parameters | osid.type.Type | workRecordType | a work record type |
Return | osid.resourcing.records.WorkSearchOrderRecord | the work search order record | |
Errors | NULL_ARGUMENT | workRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(workRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |