OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.Availability
Implementsosid.OsidRelationship
Description

An Availability represents a resource's availability for work. A competency may be used to qualify how the resource can be applied to the work. The effective dates of this relationship specify the availability dates for the resource.

MethodgetResourceId
Description

Gets the resource Id.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetJobId
Description

Gets the job Id.

Returnosid.id.Idthe job Id
CompliancemandatoryThis method must be implemented.
MethodgetJob
Description

Gets the job.

Returnosid.resourcing.Jobthe job
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisCompetent
Description

Tests if a competency is specified for this availability.

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

Gets the competency Id.

Returnosid.id.Idthe competency Id
ErrorsILLEGAL_STATE isCompetent() is false
CompliancemandatoryThis method must be implemented.
MethodgetCompetency
Description

Gets the competency.

Returnosid.resourcing.Competencythe competency
ErrorsILLEGAL_STATE isCompetent() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPercentage
Description

Gets the percentage availability.

Returncardinalthe percentage availability
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityRecord
Description

Gets the availability record corresponding to the given Availability record Type. This method is used to retrieve an object implementing the requested record. The availabilityRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(availabilityRecordType) is true .

Parametersosid.type.TypeavailabilityRecordTypethe type of availability record to retrieve
Returnosid.resourcing.records.AvailabilityRecordthe availability record
ErrorsNULL_ARGUMENT availabilityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(availabilityRecordType) is false
CompliancemandatoryThis method must be implemented.