OSID - osid.course.program.ProgramForm Service Interface Definition

Interface	osid.course.program.ProgramForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidOperableForm`
Implemented By	`osid.course.program.batch.ProgramBatchForm`
Used By	`osid.course.program.ProgramAdminSession`
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.
Method	getTitleMetadata
Description	Gets the metadata for a program title.
Return	`osid.Metadata`		metadata for the title
Compliance	`mandatory`		This method must be implemented.
Method	setTitle
Description	Sets the title.
Parameters	`string`	`title`	the new title
Errors	INVALID_ARGUMENT		`title` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`title` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTitle
Description	Removes the title.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getNumberMetadata
Description	Gets the metadata for a program number.
Return	`osid.Metadata`		metadata for the program number
Compliance	`mandatory`		This method must be implemented.
Method	setNumber
Description	Sets the program number.
Parameters	`string`	`number`	the new program number
Errors	INVALID_ARGUMENT		`number` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`number` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearNumber
Description	Removes the program number.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorsMetadata
Description	Gets the metadata for a set of sponsors.
Return	`osid.Metadata`		metadata for the sponsors
Compliance	`mandatory`		This method must be implemented.
Method	setSponsors
Description	Sets the sponsors.
Parameters	`osid.id.Id[]`	`resourceIds`	the new sponsors
Errors	INVALID_ARGUMENT		`resourceIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsors
Description	Removes the sponsors.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramMetadata
Description	Gets the metadata for the parent program.
Return	`osid.Metadata`		metadata for the parent program
Compliance	`mandatory`		This method must be implemented.
Method	setParentProgram
Description	Sets the parent program.
Parameters	`osid.id.Id`	`programId`	the new parent program
Errors	INVALID_ARGUMENT		`programId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentProgram
Description	Removes the parent program.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectivesMetadata
Description	Gets the metadata for the learning objectives.
Return	`osid.Metadata`		metadata for the learning objectives
Compliance	`mandatory`		This method must be implemented.
Method	setLearningObjectives
Description	Sets the learning objectives.
Parameters	`osid.id.Id[]`	`objectiveIds`	the new learning objectives
Errors	INVALID_ARGUMENT		`objectiveIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`objectiveIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectives
Description	Removes the learning objectives.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTargetAudiencesMetadata
Description	Gets the metadata for a set of target audiences.
Return	`osid.Metadata`		metadata for the target audiences
Compliance	`mandatory`		This method must be implemented.
Method	setTargetAudiences
Description	Sets the target audiences.
Parameters	`osid.id.Id[]`	`resourceIds`	the new target audiences
Errors	INVALID_ARGUMENT		`resourceIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetAudiences
Description	Removes the target audiences.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionRequirementsInfoMetadata
Description	Gets the metadata for a completion requirements informational string.
Return	`osid.Metadata`		metadata for the prerequisite information
Compliance	`mandatory`		This method must be implemented.
Method	setCompletionRequirementsInfo
Description	Sets the completion requirements information.
Parameters	`string`	`requirements`	the new requirements information
Errors	INVALID_ARGUMENT		`requirements` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`requirements` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionRequirementsInfo
Description	Removes the completion requirements information.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionRequirementsMetadata
Description	Gets the metadata for the completion requirements.
Return	`osid.Metadata`		metadata for the requisites
Compliance	`mandatory`		This method must be implemented.
Method	setCompletionRequirements
Description	Sets the completion requirements.
Parameters	`osid.id.Id[]`	`requisiteIds`	the new requisites
Errors	INVALID_ARGUMENT		`requisiteIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`requisiteIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionRequirements
Description	Removes the completion requirements.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialsMetadata
Description	Gets the metadata for a set of credentials.
Return	`osid.Metadata`		metadata for the credentials
Compliance	`mandatory`		This method must be implemented.
Method	setCredentials
Description	Sets the credentials.
Parameters	`osid.id.Id[]`	`credentialIds`	the new credentials
Errors	INVALID_ARGUMENT		`credentialIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`credentialIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCredentials
Description	Removes the credentials.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramFormRecord
Description	Gets the `ProgramFormRecord` corresponding to the given program record `Type`.
Parameters	`osid.type.Type`	`programRecordType`	a program record type
Return	`osid.course.program.records.ProgramFormRecord`		the program form record
Errors	NULL_ARGUMENT		`programRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.