OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ParticipantForm
Implementsosid.OsidRelationshipForm
Description

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

MethodgetTimePeriodMetadata
Description

Gets the metadata for a time period.

Returnosid.Metadatametadata for the time period
CompliancemandatoryThis method must be implemented.
MethodsetTimePeriod
Description

Sets the time period.

Parametersosid.id.IdtimePeriodIdthe time period
ErrorsINVALID_ARGUMENT timePeriodId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT timePeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimePeriod
Description

Clears the time period.

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

Gets the metadata for the grading options.

Returnosid.Metadatametadata for the prerequisite information
CompliancemandatoryThis method must be implemented.
MethodsetResultOptions
Description

Sets the grading options.

Parametersosid.id.Id[]gradeSystemIdsthe new grading options
ErrorsINVALID_ARGUMENT gradeSystemIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeSystemIds is null
CompliancemandatoryThis method must be implemented.
MethodclearResultOptions
Description

Removes the grading options.

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

Gets the ParticipantFormRecord interface corresponding to the given participant record Type.

Parametersosid.type.TypeparticipantRecordTypethe participant record type
Returnosid.offering.records.ParticipantFormRecordthe record
ErrorsNULL_ARGUMENT participantRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(participantRecordType) is false
CompliancemandatoryThis method must be implemented.