Interface AssessmentOfferedBatchForm

All Superinterfaces:

AssessmentOfferedForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

public interface AssessmentOfferedBatchForm
extends AssessmentOfferedForm

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

Method Summary

Modifier and Type	Method	Description
Id	getAssessmentId()	Gets the Assessment Id of the assessment offered if this is a create transaction.
Id	getAssessmentOfferedId()	Gets the Id of the assessment offered to be updated if this is an update transaction.

Methods inherited from interface AssessmentOfferedForm

clearDeadline, clearDuration, clearGradeSystem, clearItemsSequential, clearItemsShuffled, clearLevel, clearScoreSystem, clearStartTime, getAssessmentOfferedFormRecord, getDeadlineMetadata, getDurationMetadata, getGradeSystemMetadata, getItemsSequentialMetadata, getItemsShuffledMetadata, getLevelMetadata, getScoreSystemMetadata, getStartTimeMetadata, setDeadline, setDuration, setGradeSystem, setItemsSequential, setItemsShuffled, setLevel, setScoreSystem, setStartTime

Modifier and Type	Method	Description
void	clearDeadline()	Clears the deadline.
void	clearDuration()	Clears the duration.
void	clearGradeSystem()	Clears the grading system.
void	clearItemsSequential()	Clears the items sequential flag.
void	clearItemsShuffled()	Clears the shuffle flag.
void	clearLevel()	Clears the level.
void	clearScoreSystem()	Clears the score system.
void	clearStartTime()	Clears the start time.
AssessmentOfferedFormRecord	getAssessmentOfferedFormRecord(Type assessmentOfferedRecordType)	Gets the AssessmentOfferedFormRecord corresponding to the given assessment record Type .
Metadata	getDeadlineMetadata()	Gets the metadata for the assessment deadline.
Metadata	getDurationMetadata()	Gets the metadata for the assessment duration
Metadata	getGradeSystemMetadata()	Gets the metadata for a grading system.
Metadata	getItemsSequentialMetadata()	Gets the metadata for sequential operation.
Metadata	getItemsShuffledMetadata()	Gets the metadata for shuffling items.
Metadata	getLevelMetadata()	Gets the metadata for a grade level.
Metadata	getScoreSystemMetadata()	Gets the metadata for a score system.
Metadata	getStartTimeMetadata()	Gets the metadata for the assessment start time.
void	setDeadline(DateTime end)	Sets the assessment end time.
void	setDuration(Duration duration)	Sets the assessment duration.
void	setGradeSystem(Id gradeSystemId)	Sets the grading system.
void	setItemsSequential(boolean sequential)	Sets the items sequential flag.
void	setItemsShuffled(boolean shuffle)	Sets the shuffle flag.
void	setLevel(Id gradeId)	Sets the level of difficulty expressed as a Grade .
void	setScoreSystem(Id gradeSystemId)	Sets the scoring system.
void	setStartTime(DateTime start)	Sets the assessment start time.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

getAssessmentId

Id getAssessmentId()

Gets the Assessment Id of the assessment offered if this is a create transaction.

Returns:

the assessment Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getAssessmentOfferedId

Id getAssessmentOfferedId()

Gets the Id of the assessment offered to be updated if this is an update transaction.

Returns:

the assessment offered Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.