org.osid.course.plan

Interface PlanForm

All Superinterfaces:

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

public interface PlanForm
extends OsidRelationshipForm

This is the form for creating and updating Plan objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PlanAdminSession. 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	clearModules() Clears the modules.
Metadata	getModulesMetadata() Gets the metadata for the modules.
PlanFormRecord	getPlanFormRecord(Type planRecordType) Gets the PlanFormRecord corresponding to the given plan record Type.
void	setModules(IdList moduleIds) Sets the modules to which this plan applies.

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

getModulesMetadata

Metadata getModulesMetadata()

Gets the metadata for the modules.

Returns:

metadata for the modules

Compliance:

mandatory - This method must be implemented.

setModules

void setModules(IdList moduleIds)

Sets the modules to which this plan applies.

Parameters:

moduleIds - the new modules

Throws:

InvalidArgumentException - moduleIds is invalid

NoAccessException - moduleIds cannot be modified

NullArgumentException - moduleIds is null

Compliance:

mandatory - This method must be implemented.

clearModules

void clearModules()

Clears the modules.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPlanFormRecord

PlanFormRecord getPlanFormRecord(Type planRecordType)
                                 throws OperationFailedException

Gets the PlanFormRecord corresponding to the given plan record Type.

Parameters:

planRecordType - the plan record type

Returns:

the plan form record

Throws:

NullArgumentException - planRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planRecordType) is false

Compliance:

mandatory - This method must be implemented.