OSID - osid.assessment.AssessmentOfferedForm Service Interface Definition

Interface	osid.assessment.AssessmentOfferedForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.assessment.batch.AssessmentOfferedBatchForm`
Used By	`osid.assessment.AssessmentOfferedAdminSession`
Description	This is the form for creating and updating an `AssessmentOffered`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `AssessmentOfferedAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getLevelMetadata
Description	Gets the metadata for a grade level.
Return	`osid.Metadata`		metadata for the grade level
Compliance	`mandatory`		This method must be implemented.
Method	setLevel
Description	Sets the level of difficulty expressed as a `Grade`.
Parameters	`osid.id.Id`	`gradeId`	the grade level
Errors	INVALID_ARGUMENT		`gradeId` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearLevel
Description	Clears the level.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getItemsSequentialMetadata
Description	Gets the metadata for sequential operation.
Return	`osid.Metadata`		metadata for the sequential flag
Compliance	`mandatory`		This method must be implemented.
Method	setItemsSequential
Description	Sets the items sequential flag.
Parameters	`boolean`	`sequential`	`true` if the items are taken sequentially, `false` if the items can be skipped and revisited
Errors	INVALID_ARGUMENT		`sequential` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemsSequential
Description	Clears the items sequential flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getItemsShuffledMetadata
Description	Gets the metadata for shuffling items.
Return	`osid.Metadata`		metadata for the shuffled flag
Compliance	`mandatory`		This method must be implemented.
Method	setItemsShuffled
Description	Sets the shuffle flag. The shuffle flag may be overidden by other assessment sequencing rules.
Parameters	`boolean`	`shuffle`	`true` if the items are shuffled, `false` if the items appear in the designated order
Errors	INVALID_ARGUMENT		`shuffle` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemsShuffled
Description	Clears the shuffle flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStartTimeMetadata
Description	Gets the metadata for the assessment start time.
Return	`osid.Metadata`		metadata for the start time
Compliance	`mandatory`		This method must be implemented.
Method	setStartTime
Description	Sets the assessment start time.
Parameters	`osid.calendaring.DateTime`	`start`	assessment start time
Errors	INVALID_ARGUMENT		`start` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearStartTime
Description	Clears the start time.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDeadlineMetadata
Description	Gets the metadata for the assessment deadline.
Return	`osid.Metadata`		metadata for the end time
Compliance	`mandatory`		This method must be implemented.
Method	setDeadline
Description	Sets the assessment end time.
Parameters	`osid.calendaring.DateTime`	`end`	assessment end time
Errors	INVALID_ARGUMENT		`end` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearDeadline
Description	Clears the deadline.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDurationMetadata
Description	Gets the metadata for the assessment duration
Return	`osid.Metadata`		metadata for the duration
Compliance	`mandatory`		This method must be implemented.
Method	setDuration
Description	Sets the assessment duration.
Parameters	`osid.calendaring.Duration`	`duration`	assessment duration
Errors	INVALID_ARGUMENT		`duration` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearDuration
Description	Clears the duration.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScoreSystemMetadata
Description	Gets the metadata for a score system.
Return	`osid.Metadata`		metadata for the grade system
Compliance	`mandatory`		This method must be implemented.
Method	setScoreSystem
Description	Sets the scoring system.
Parameters	`osid.id.Id`	`gradeSystemId`	the grade system
Errors	INVALID_ARGUMENT		`gradeSystemId` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearScoreSystem
Description	Clears the score system.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemMetadata
Description	Gets the metadata for a grading system.
Return	`osid.Metadata`		metadata for the grade system
Compliance	`mandatory`		This method must be implemented.
Method	setGradeSystem
Description	Sets the grading system.
Parameters	`osid.id.Id`	`gradeSystemId`	the grade system
Errors	INVALID_ARGUMENT		`gradeSystemId` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeSystem
Description	Clears the grading system.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentOfferedFormRecord
Description	Gets the `AssessmentOfferedFormRecord` corresponding to the given assessment record `Type`.
Parameters	`osid.type.Type`	`assessmentOfferedRecordType`	the assessment offered record type
Return	`osid.assessment.records.AssessmentOfferedFormRecord`		the assessment offered record
Errors	NULL_ARGUMENT		`assessmentOfferedRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentOfferedRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.