public interface ActivityForm extends OsidObjectForm, OsidSubjugateableForm
This is the form for creating and updating Activities.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
ActivityAdminSession.
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 |
clearCourses()
Clears the courses.
|
ActivityFormRecord |
getActivityFormRecord(Type activityRecordType)
Gets the
ActivityFormRecord corresponding to the given
activity record Type. |
Metadata |
getAssessmentsMetadata()
Gets the metadata for the assessments.
|
Metadata |
getAssetsMetadata()
Gets the metadata for the assets.
|
Metadata |
getCoursesMetadata()
Gets the metadata for the courses.
|
void |
setAssessments(Id[] assessmentIds)
Sets the assessments.
|
void |
setAssets(Id[] assetIds)
Sets the assets.
|
void |
setCourses(Id[] courseIds)
Sets the courses.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getAssetsMetadata()
mandatory
- This method must be implemented. void setAssets(Id[] assetIds)
assetIds
- the asset Ids
InvalidArgumentException
- assetIds
is
invalidNullArgumentException
- assetIds
is
null
NoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAssets()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCoursesMetadata()
mandatory
- This method must be implemented. void setCourses(Id[] courseIds)
courseIds
- the course Ids
InvalidArgumentException
- courseIds
is
invalidNullArgumentException
- courseIds
is
null
NoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearCourses()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAssessmentsMetadata()
mandatory
- This method must be implemented. void setAssessments(Id[] assessmentIds)
assessmentIds
- the assessment Ids
InvalidArgumentException
- assessmentIds
is invalidNullArgumentException
- assessmentIds
is
null
NoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAssessments()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ActivityFormRecord getActivityFormRecord(Type activityRecordType) throws OperationFailedException
ActivityFormRecord
corresponding to the given
activity record Type.
activityRecordType
- the activity record typeNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRecordType)
is false
mandatory
- This method must be implemented.