OSID Logo
OSID Specifications
resourcing package
Version 3.0.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.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodsupportsJobSearchOrder
Description

Tests if a job search order is available.

Returnbooleantrue 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_STATEsupportsJobSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCreatedDate
Description

Orders the results by the created date.

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

Orders the results by the completion date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle 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_ARGUMENTworkRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(workRecordType) is false
CompliancemandatoryThis method must be implemented.