org.osid.resourcing

Interface Effort

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Effort
extends OsidRelationship

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.

Method Summary

Methods

Modifier and Type	Method and Description
Commission	getCommission() Gets the commission.
Id	getCommissionId() Gets the Id of the commission.
EffortRecord	getEffortRecord(Type effortRecordType) Gets the effort record corresponding to the given Effort record Type.
Resource	getResource() Gets the resource.
Id	getResourceId() Gets the Id of the resource.
Duration	getTimeSpent() Gets the time spent on this commission.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getResourceId

Id getResourceId()

Gets the Id of the resource.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getResource

Resource getResource()
                     throws OperationFailedException

Gets the resource.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCommissionId

Id getCommissionId()

Gets the Id of the commission.

Returns:

the commission Id

Compliance:

mandatory - This method must be implemented.

getCommission

Commission getCommission()
                         throws OperationFailedException

Gets the commission.

Returns:

the commission

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTimeSpent

Duration getTimeSpent()

Gets the time spent on this commission.

Returns:

the time spent

Compliance:

mandatory - This method must be implemented.

getEffortRecord

EffortRecord getEffortRecord(Type effortRecordType)
                             throws OperationFailedException

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 .

Parameters:

effortRecordType - the type of effort record to retrieve

Returns:

the effort record

Throws:

NullArgumentException - effortRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(effortRecordType) is false

Compliance:

mandatory - This method must be implemented.