Interface DocetBatchForm

All Superinterfaces:

DocetForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

public interface DocetBatchForm
extends DocetForm

This is the form for creating and updating docets in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DocetBatchAdminSession . 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	getActivityUnitId()	Gets the activity unit Id of the docet if this is a create transaction.
Id	getDocetId()	Gets the Id of the docet to be updated if this is an update transaction.
Id	getModuleId()	Gets the module Id of the docet if this is a create transaction.

Methods inherited from interface DocetForm

clearAssessments, clearAssets, clearDuration, clearInClass, clearLearningObjectives, getAssessmentsMetadata, getAssetsMetadata, getDocetFormRecord, getDurationMetadata, getInClassMetadata, getLearningObjectivesMetadata, setAssessments, setAssets, setDuration, setInClass, setLearningObjectives

Modifier and Type	Method	Description
void	clearAssessments()	Clears the assessments.
void	clearAssets()	Clears the assets.
void	clearDuration()	Clears the duration.
void	clearInClass()	Clears the in class flag.
void	clearLearningObjectives()	Clears the in class flag.
Metadata	getAssessmentsMetadata()	Gets the metadata for the assessments.
Metadata	getAssetsMetadata()	Gets the metadata for the assets.
DocetFormRecord	getDocetFormRecord(Type docetRecordType)	Gets the DocetFormRecord corresponding to the given docet record Type .
Metadata	getDurationMetadata()	Gets the metadata for the duration.
Metadata	getInClassMetadata()	Gets the metadata for the in class flag.
Metadata	getLearningObjectivesMetadata()	Gets the metadata for the learning obectives.
void	setAssessments(IdList assessmentIds)	Sets the assessments.
void	setAssets(IdList assetIds)	Sets the assets.
void	setDuration(Duration duration)	Sets the duration.
void	setInClass(boolean inClass)	Sets the in class flag.
void	setLearningObjectives(IdList objectiveIds)	Sets the learning objectives.

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.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getModuleId

Id getModuleId()

Gets the module Id of the docet if this is a create transaction.

Returns:

the module Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getActivityUnitId

Id getActivityUnitId()

Gets the activity unit Id of the docet if this is a create transaction.

Returns:

the activity unit Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getDocetId

Id getDocetId()

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

Returns:

the docet Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.