OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.WorkSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByJob
Description

Orders the results by the job.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsJobSearchOrder
Description

Tests if a job search order is available.

Returnboolean true if a job search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetJobSearchOrder
Description

Gets the job search order.

Returnosid.resourcing.JobSearchOrderthe job search order
ErrorsILLEGAL_STATE supportsJobSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCreatedDate
Description

Orders the results by the created date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCompletionDate
Description

Orders the results by the completion date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetWorkSearchOrderRecord
Description

Gets the work search order record corresponding to the given work record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeworkRecordTypea work record type
Returnosid.resourcing.records.WorkSearchOrderRecordthe work search order record
ErrorsNULL_ARGUMENT workRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(workRecordType) is false
CompliancemandatoryThis method must be implemented.