OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.Effort
Implementsosid.OsidRelationship
Used Byosid.resourcing.EffortAdminSession
osid.resourcing.EffortList
osid.resourcing.EffortLookupSession
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.Id the resource Id
Compliancemandatory This method must be implemented.
MethodgetResource
Description

Gets the resource.

Returnosid.resource.Resource the resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetCommissionId
Description

Gets the Id of the commission.

Returnosid.id.Id the commission Id
Compliancemandatory This method must be implemented.
MethodgetCommission
Description

Gets the commission.

Returnosid.resourcing.Commission the commission
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetTimeSpent
Description

Gets the time spent on this commission.

Returnosid.calendaring.Duration the time spent
Compliancemandatory This 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.TypeeffortRecordType the type of effort record to retrieve
Returnosid.resourcing.records.EffortRecord the effort record
ErrorsNULL_ARGUMENT effortRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(effortRecordType) is false
Compliancemandatory This method must be implemented.