org.osid.course.requisite

Interface AwardRequirementForm

All Superinterfaces:

Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface AwardRequirementForm
extends OsidRuleForm, OsidAggregateableForm

This is the form for creating and updating AwardRequirements. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RequisiteAdminSession. 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	clearTimeframe() Clears the timeframe.
AwardRequirementFormRecord	getAwardlRequirementFormRecord(Type awardRequirementRecordType) Gets the AwardRequirementFormRecord corresponding to the given awardl requirement record Type.
Metadata	getTimeframeMetadata() Gets the metadata for the timeframe.
void	setTimeframe(Duration duration) Sets the timeframe.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getTimeframeMetadata

Metadata getTimeframeMetadata()

Gets the metadata for the timeframe.

Returns:

metadata for the timeframe

Compliance:

mandatory - This method must be implemented.

setTimeframe

void setTimeframe(Duration duration)

Sets the timeframe.

Parameters:

duration - the new duration

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearTimeframe

void clearTimeframe()

Clears the timeframe.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAwardlRequirementFormRecord

AwardRequirementFormRecord getAwardlRequirementFormRecord(Type awardRequirementRecordType)
                                                          throws OperationFailedException

Gets the AwardRequirementFormRecord corresponding to the given awardl requirement record Type.

Parameters:

awardRequirementRecordType - an award requirement record type

Returns:

the award requirement form record

Throws:

NullArgumentException - awardRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.