OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramForm
Implementsosid.OsidObjectForm
osid.OsidOperableForm
Description

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

MethodgetTitleMetadata
Description

Gets the metadata for a program title.

Returnosid.Metadatametadata for the title
CompliancemandatoryThis method must be implemented.
MethodsetTitle
Description

Sets the title.

Parametersstringtitlethe new title
ErrorsINVALID_ARGUMENT title is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT title is null
CompliancemandatoryThis method must be implemented.
MethodclearTitle
Description

Removes the title.

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

Gets the metadata for a program number.

Returnosid.Metadatametadata for the program number
CompliancemandatoryThis method must be implemented.
MethodsetNumber
Description

Sets the program number.

Parametersstringnumberthe new program number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearNumber
Description

Removes the program number.

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

Gets the metadata for a set of sponsors.

Returnosid.Metadatametadata for the sponsors
CompliancemandatoryThis method must be implemented.
MethodsetSponsors
Description

Sets the sponsors.

Parametersosid.id.Id[]resourceIdsthe new sponsors
ErrorsINVALID_ARGUMENT resourceIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceIds is null
CompliancemandatoryThis method must be implemented.
MethodclearSponsors
Description

Removes the sponsors.

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

Gets the metadata for a completion requirements informational string.

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

Sets the completion requirements information.

Parametersstringrequirementsthe new requirements information
ErrorsINVALID_ARGUMENT requirements is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT requirements is null
CompliancemandatoryThis method must be implemented.
MethodclearCompletionRequirementsInfo
Description

Removes the completion requirements information.

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

Gets the metadata for a completion requirements requisites.

Returnosid.Metadatametadata for the requisites
CompliancemandatoryThis method must be implemented.
MethodsetCompletionRequirements
Description

Sets the completion requirements requisites.

Parametersosid.id.Id[]requisiteIdsthe new requisites
ErrorsINVALID_ARGUMENT ruleId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT requisiteIds is null
CompliancemandatoryThis method must be implemented.
MethodclearCompletionRequirements
Description

Removes the completion requirements requisites.

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

Gets the metadata for a set of credentials.

Returnosid.Metadatametadata for the credentials
CompliancemandatoryThis method must be implemented.
MethodsetCredentials
Description

Sets the credentials.

Parametersosid.id.Id[]credentialIdsthe new credentials
ErrorsINVALID_ARGUMENT gradeSystemIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT credentialIds is null
CompliancemandatoryThis method must be implemented.
MethodclearCredentials
Description

Removes the credentials.

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

Gets the ProgramFormRecord corresponding to the given program record Type.

Parametersosid.type.TypeprogramRecordTypea program record type
Returnosid.course.program.records.ProgramFormRecordthe program form record
ErrorsNULL_ARGUMENT programRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programRecordType) is false
CompliancemandatoryThis method must be implemented.