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.

Like all OsidForms, DocetBatchForm is stateful and must not be accessed by multiple processing threads.

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

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface Identifiable

getId, isCurrent

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface OsidForm

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

Methods inherited from interface OsidObjectForm

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

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

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.