org.osid.resourcing

Interface EffortForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

EffortBatchForm

public interface EffortForm
extends OsidRelationshipForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearTimeSpent() Removes the time spent.
EffortFormRecord	getEffortFormRecord(Type effortRecordType) Gets the EffortFormRecord corresponding to the given effort record Type.
Metadata	getTimeSpentMetadata() Gets the metadata for the time spent.
void	setTimeSpent(Duration timeSpent) Sets the time spent.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getTimeSpentMetadata

Metadata getTimeSpentMetadata()

Gets the metadata for the time spent.

Returns:

metadata for the time spent

Compliance:

mandatory - This method must be implemented.

setTimeSpent

void setTimeSpent(Duration timeSpent)

Sets the time spent.

Parameters:

timeSpent - the new time spent

Throws:

InvalidArgumentException - timeSpent is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - timeSpent is null

Compliance:

mandatory - This method must be implemented.

clearTimeSpent

void clearTimeSpent()

Removes the time spent.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getEffortFormRecord

EffortFormRecord getEffortFormRecord(Type effortRecordType)
                                     throws OperationFailedException

Gets the EffortFormRecord corresponding to the given effort record Type.

Parameters:

effortRecordType - an effort record type

Returns:

the effort form record

Throws:

NullArgumentException - effortRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(effortRecordType) is false

Compliance:

mandatory - This method must be implemented.