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

An Effort captures actual time spent on a commission. The time spent may be used to further qualify the effort that took place within the effective dates. Multiple efforts may be logged between a resource and a commission to capture discontiguous periosds of time.

MethodgetResourceId
Description

Gets the Id of the resource.

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.
MethodgetCommissionId
Description

Gets the Id of the commission.

Returnosid.id.Idthe commission Id
CompliancemandatoryThis method must be implemented.
MethodgetCommission
Description

Gets the commission.

Returnosid.resourcing.Commissionthe commission
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTimeSpent
Description

Gets the time spent on this commission.

Returnosid.calendaring.Durationthe time spent
CompliancemandatoryThis method must be implemented.
MethodgetEffortRecord
Description

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

Parametersosid.type.TypeeffortRecordTypethe type of effort record to retrieve
Returnosid.resourcing.records.EffortRecordthe effort record
ErrorsNULL_ARGUMENT effortRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(effortRecordType) is false
CompliancemandatoryThis method must be implemented.