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

Interface	osid.course.program.ProgramOfferingForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.program.batch.ProgramOfferingBatchForm`
Used By	`osid.course.program.ProgramOfferingAdminSession`
Description	This is the form for creating and updating `ProgramOfferings`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ProgramOfferingAdminSession`. 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 offering 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 the 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[]`	`sponsorIds`	the new sponsors
Errors	INVALID_ARGUMENT		`sponsorIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`sponsorIds` 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	getParentProgramOfferingMetadata
Description	Gets the metadata for the parent program offering.
Return	`osid.Metadata`		metadata for the parent program offering
Compliance	`mandatory`		This method must be implemented.
Method	setParentProgramOffering
Description	Sets the parent program offering.
Parameters	`osid.id.Id`	`programOfferingId`	the new parent program offering
Errors	INVALID_ARGUMENT		`programOfferingId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`programOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentProgramOffering
Description	Removes the parent program offering.
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	getRestrictedAudiencesMetadata
Description	Gets the metadata for a set of restricted audiences.
Return	`osid.Metadata`		metadata for the restricted audiences
Compliance	`mandatory`		This method must be implemented.
Method	setRestrictedAudiences
Description	Sets the restricted audiences.
Parameters	`osid.id.Id[]`	`resourceIds`	the new restricted 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	clearRestrictedAudiences
Description	Removes the restricted 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 a completion requirements requisites.
Return	`osid.Metadata`		metadata for the requisites
Compliance	`mandatory`		This method must be implemented.
Method	setCompletionRequirements
Description	Sets the completion requirements requisites.
Parameters	`osid.id.Id[]`	`requisiteIds`	the new requisites
Errors	INVALID_ARGUMENT		`ruleId` 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 requisites.
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		`gradeSystemIds` 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	getRequiresRegistrationMetadata
Description	Gets the metadata for requires registration flag.
Return	`osid.Metadata`		metadata for registration flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequiresRegistration
Description	Sets the requires registration flag.
Parameters	`boolean`	`requiresRegistration`	the new registration flag
Errors	INVALID_ARGUMENT		`requiresRegistration` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresRegistration
Description	Removes the requires registration flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumSeatsMetadata
Description	Gets the metadata for the minimum seats.
Return	`osid.Metadata`		metadata for the minimum seats
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumSeats
Description	Sets the minimum seating count.
Parameters	`cardinal`	`seats`	the new minimum seats
Errors	INVALID_ARGUMENT		`seats` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumSeats
Description	Removes the minimum seats.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumSeatsMetadata
Description	Gets the metadata for the maximum seats.
Return	`osid.Metadata`		metadata for the maximum seats
Compliance	`mandatory`		This method must be implemented.
Method	setMaximumSeats
Description	Sets the maximum seating count.
Parameters	`cardinal`	`seats`	the new maximum seats
Errors	INVALID_ARGUMENT		`seats` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumSeats
Description	Removes the maximum seats.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getURLMetadata
Description	Gets the metadata for a program url.
Return	`osid.Metadata`		metadata for the url
Compliance	`mandatory`		This method must be implemented.
Method	setURL
Description	Sets the url for a program web site.
Parameters	`string`	`url`	the new url
Errors	INVALID_ARGUMENT		`url` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`url` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearURL
Description	Removes the url.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingFormRecord
Description	Gets the `ProgramOfferingFormRecord` corresponding to the given program offering record `Type`.
Parameters	`osid.type.Type`	`programOfferingRecordType`	a program offering record type
Return	`osid.course.program.records.ProgramOfferingFormRecord`		the program offering form record
Errors	NULL_ARGUMENT		`programOfferingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programOfferingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.