OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.AvailabilitySearchOrder
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.
MethodorderByJob
Description

Orders the results by 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.
MethodorderByCompetency
Description

Orders the results by competency.

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

Tests if a competency search order is available.

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

Gets the competency search order.

Returnosid.resourcing.CompetencySearchOrderthe competency search order
ErrorsILLEGAL_STATE supportsCompetencySearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByPercentage
Description

Orders the results by percentage availability.

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

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

Parametersosid.type.TypeavailabilityRecordTypean availability record type
Returnosid.resourcing.records.AvailabilitySearchOrderRecordthe availability order record
ErrorsNULL_ARGUMENT availabilityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(availabilityRecordType) is false
CompliancemandatoryThis method must be implemented.