public interface DocetForm extends OsidRelationshipForm
This is the form for creating and updating Docets.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the DocetAdminSession.
For each data element that may be set, metadata may be examined to
provide display hints or data constraints.
Modifier and Type | Method and 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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getLearningObjectivesMetadata()
mandatory
- This method must be implemented. void setLearningObjectives(IdList objectiveIds)
objectiveIds
- the new objectivesInvalidArgumentException
- objectiveIds
is invalidNoAccessException
- objectiveIds
cannot
be modifiedNullArgumentException
- objectiveIds
is
null
mandatory
- This method must be implemented. void clearLearningObjectives()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getInClassMetadata()
mandatory
- This method must be implemented. void setInClass(boolean inClass)
inClass
- the new in class flagInvalidArgumentException
- inClass
is
invalidNoAccessException
- inClass
cannot be
modifiedmandatory
- This method must be implemented. void clearInClass()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDurationMetadata()
mandatory
- This method must be implemented. void setDuration(Duration duration)
duration
- the new durationInvalidArgumentException
- duration
is
invalidNoAccessException
- duration
cannot be
modifiedNullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearDuration()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAssetsMetadata()
mandatory
- This method must be implemented. void setAssets(IdList assetIds)
assetIds
- the new assetsInvalidArgumentException
- assetIds
is
invalidNoAccessException
- assetIds
cannot be
modifiedNullArgumentException
- assetIds
is
null
mandatory
- This method must be implemented. void clearAssets()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAssessmentsMetadata()
mandatory
- This method must be implemented. void setAssessments(IdList assessmentIds)
assessmentIds
- the new assessmentsInvalidArgumentException
- assessmentIds
is invalidNoAccessException
- assessmentIds
cannot
be modifiedNullArgumentException
- assessmentIds
is
null
mandatory
- This method must be implemented. void clearAssessments()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. DocetFormRecord getDocetFormRecord(Type docetRecordType) throws OperationFailedException
DocetFormRecord
corresponding to the given
docet record Type.
docetRecordType
- the docet record typeNullArgumentException
- docetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(docetRecordType)
is false
mandatory
- This method must be implemented.