OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.EffortSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Orders the results by resource.

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

Tests if a resource search order is available.

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

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsResourceSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCommission
Description

Orders the results by the commission.

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

Tests if a commission search order is available.

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

Gets the commission search order.

Returnosid.resourcing.CommissionSearchOrderthe commission search order
ErrorsILLEGAL_STATE supportsCommissionSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByTimeSpent
Description

Orders the results by the time spent.

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

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

Parametersosid.type.TypeeffortRecordTypean effort record type
Returnosid.resourcing.records.EffortSearchOrderRecordthe effort search order record
ErrorsNULL_ARGUMENT effortRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(effortRecordType) is false
CompliancemandatoryThis method must be implemented.