org.osid.course.requisite

Interface CredentialRequirementForm

All Superinterfaces:

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

public interface CredentialRequirementForm
extends OsidRuleForm, OsidAggregateableForm

This is the form for creating and updating CredentialRequirements. 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.
CredentialRequirementFormRecord	getCredentialRequirementFormRecord(Type credentialRequirementRecordType) Gets the CredentialRequirementFormRecord corresponding to the given credential 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.

getCredentialRequirementFormRecord

CredentialRequirementFormRecord getCredentialRequirementFormRecord(Type credentialRequirementRecordType)
                                                                   throws OperationFailedException

Gets the CredentialRequirementFormRecord corresponding to the given credential requirement record Type.

Parameters:

credentialRequirementRecordType - a credential requirement record type

Returns:

the credential requirement form record

Throws:

NullArgumentException - credentialRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.