OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.WorkSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.resourcing.CommissionSearchOrder
osid.resourcing.WorkSearchSession
osid.resourcing.WorkSmartFoundrySession
Description

An interface for specifying the ordering of search results.

MethodorderByJob
Description

Orders the results by the job.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetJobSearchOrder
Description

Gets the job search order.

Returnosid.resourcing.JobSearchOrder the job search order
ErrorsILLEGAL_STATE supportsJobSearchOrder() is false
Compliancemandatory This method must be implemented.
MethodorderByCreatedDate
Description

Orders the results by the created date.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByCompletionDate
Description

Orders the results by the completion date.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypeworkRecordType a work record type
Returnosid.resourcing.records.WorkSearchOrderRecord the work search order record
ErrorsNULL_ARGUMENT workRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(workRecordType) is false
Compliancemandatory This method must be implemented.