public interface Docet extends OsidRelationship
An Docet
is an OsidRelationship
between a
Module
and an ActivityUnit.
A Docet
may represent a descriptive portion of an in-class lesson plan, an
assignment, or an assessment. A Docet may exist at any level of
granularity. A Docet may cover an entire Module or there may be lots of
Docets specific to fine-grained learning objectives.
Modifier and Type | Method and Description |
---|---|
ActivityUnit |
getActivityUnit()
Gets the activity unit.
|
Id |
getActivityUnitId()
Gets the
Id of the activity unit. |
IdList |
getAssessmentIds()
Gets a list of assessments.
|
AssessmentList |
getAssessments()
Gets the assessments.
|
IdList |
getAssetIds()
Gets a list of asset materials distributed to the students.
|
AssetList |
getAssets()
Gets the assets distributed to the students.
|
DocetRecord |
getDocetRecord(Type docetRecordType)
Gets the docet record corresponding to the given
Docet
record Type. |
Duration |
getDuration()
Gets the estimated duration.
|
IdList |
getLearningObjectiveIds()
Gets the
Ids of the learning objectives. |
ObjectiveList |
getLearningObjectives()
Gets the learning objectives.
|
Module |
getModule()
Gets the learning module
|
Id |
getModuleId()
Gets the
Ids of the learning module. |
boolean |
hasAssessments()
Tests if this
Docet has a quiz or assignment expressed
as an Assessment . |
boolean |
hasAssets()
Tests if this
Docet has a reading materials expressed
as Assets. |
boolean |
isInClass()
Tests if this
Docet occurs within an Activity
or it outlines efforts spent outside a convened activity. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getModuleId()
Ids
of the learning module. Id
mandatory
- This method must be implemented. Module getModule() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getActivityUnitId()
Id
of the activity unit. Id
mandatory
- This method must be implemented. ActivityUnit getActivityUnit() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getLearningObjectiveIds()
Ids
of the learning objectives. Ids
mandatory
- This method must be implemented. ObjectiveList getLearningObjectives() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isInClass()
Docet
occurs within an Activity
or it outlines efforts spent outside a convened activity. In
class docets can be used to align the estimated duration with the
schedule of activities. true
if this occurs within an activity,
false
if occurs outside a convened activitymandatory
- This method must be implemented. Duration getDuration()
mandatory
- This method must be implemented. boolean hasAssets()
Docet
has a reading materials expressed
as Assets.
true
if assets are avilable, false
otherwisemandatory
- This method must be implemented. IdList getAssetIds()
Ids
IllegalStateException
- hasAssets()
is
false
mandatory
- This method must be implemented. AssetList getAssets() throws OperationFailedException
IllegalStateException
- hasAssets()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasAssessments()
Docet
has a quiz or assignment expressed
as an Assessment
. true
if assessments are avilable, false
otherwisemandatory
- This method must be implemented. IdList getAssessmentIds()
Ids
IllegalStateException
- hasAssessments()
is false
mandatory
- This method must be implemented. AssessmentList getAssessments() throws OperationFailedException
IllegalStateException
- hasAssessments()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DocetRecord getDocetRecord(Type docetRecordType) throws OperationFailedException
Docet
record Type.
This method must be used to retrieve an
object implementing the requested record. The docetRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(docetRecordType)
is true
.docetRecordType
- the type of docet record to retrieveNullArgumentException
- docetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(docetRecordType)
is false
mandatory
- This method must be implemented.