OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Interfaceosid.course.plan.PlanForm
Implementsosid.OsidRelationshipForm
Used Byosid.course.plan.PlanAdminSession
Description

This is the form for creating and updating Plans . 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.

MethodgetModulesMetadata
Description

Gets the metadata for the modules.

Returnosid.Metadatametadata for the modules
CompliancemandatoryThis method must be implemented.
MethodsetModules
Description

Sets the modules to which this plan applies.

Parametersosid.id.IdListmoduleIdsthe new modules
ErrorsINVALID_ARGUMENTmoduleIds is invalid
NO_ACCESSmoduleIds cannot be modified
NULL_ARGUMENTmoduleIds is null
CompliancemandatoryThis method must be implemented.
MethodclearModules
Description

Clears the modules.

ErrorsNO_ACCESSMetadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPlanFormRecord
Description

Gets the PlanFormRecord corresponding to the given plan record Type .

Parametersosid.type.TypeplanRecordTypethe plan record type
Returnosid.course.plan.records.PlanFormRecordthe plan form record
ErrorsNULL_ARGUMENTplanRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(planRecordType) is false
CompliancemandatoryThis method must be implemented.