org.osid.course.requisite

Interface RequisiteForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidTemporalForm, Suppliable

public interface RequisiteForm
extends OsidRuleForm, OsidEnablerForm, OsidContainableForm

This is the form for creating and updating Requisites. 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
RequisiteFormRecord	getRequisiteFormRecord(Type requisiteRecordType) Gets the RequisiteFormRecord corresponding to the given requisite record Type.

Methods inherited from interface org.osid.OsidEnablerForm

clearCyclicEvent, clearDemographic, clearEvent, clearSchedule, getCyclicEventMetadata, getDemographicMetadata, getEventMetadata, getScheduleMetadata, setCyclicEvent, setDemographic, setEvent, setSchedule

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Methods inherited from interface org.osid.OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Method Detail

getRequisiteFormRecord

RequisiteFormRecord getRequisiteFormRecord(Type requisiteRecordType)
                                           throws OperationFailedException

Gets the RequisiteFormRecord corresponding to the given requisite record Type.

Parameters:

requisiteRecordType - a requisite record type

Returns:

the requisite form record

Throws:

NullArgumentException - requisiteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requisiteRecordType) is false

Compliance:

mandatory - This method must be implemented.