OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationForm
Implementsosid.OsidRelationshipForm
Description

This is the form for creating and updating Registrations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RegistrationAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCreditsMetadata
Description

Gets the metadata for registration credits.

Returnosid.Metadatametadata for the registration credits
CompliancemandatoryThis method must be implemented.
MethodsetCredits
Description

Sets the registration credits.

Parametersdecimal[]creditsthe new registration credits
ErrorsINVALID_ARGUMENT credits is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT credits is null
CompliancemandatoryThis method must be implemented.
MethodclearCredits
Description

Removes the registration credits.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetGradingOptionMetadata
Description

Gets the metadata for the grading option.

Returnosid.Metadatametadata for the grading option
CompliancemandatoryThis method must be implemented.
MethodsetGradingOptions
Description

Sets the grading option.

Parametersosid.id.IdgradeSystemIdthe new grading option
ErrorsINVALID_ARGUMENT gradeSystemId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeSystemId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradingOption
Description

Removes the grading option.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationFormRecord
Description

Gets the RegistrationFormRecord corresponding to the given registration record Type.

Parametersosid.type.TyperegistrationRecordTypea registration record type
Returnosid.course.registration.records.RegistrationFormRecordthe registration form record
ErrorsNULL_ARGUMENT registrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(registrationRecordType) is false
CompliancemandatoryThis method must be implemented.