OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.EffortForm
Implementsosid.OsidRelationshipForm
Description

This is the form for creating and updating Efforts. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EffortAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetTimeSpentMetadata
Description

Gets the metadata for the time spent.

Returnosid.Metadatametadata for the time spent
CompliancemandatoryThis method must be implemented.
MethodsetTimeSpent
Description

Sets the time spent.

Parametersosid.calendaring.DurationtimeSpentthe new time spent
ErrorsINVALID_ARGUMENT timeSpent is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT timeSpent is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeSpent
Description

Removes the time spent.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetEffortFormRecord
Description

Gets the EffortFormRecord corresponding to the given effort record Type.

Parametersosid.type.TypeeffortRecordTypean effort record type
Returnosid.resourcing.records.EffortFormRecordthe effort form record
ErrorsNULL_ARGUMENT effortRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(effortRecordType) is false
CompliancemandatoryThis method must be implemented.