Objects¶
Objective¶
-
class
dlkit.learning.objects.Objective¶ Bases:
dlkit.osid.objects.OsidObject,dlkit.osid.markers.FederateableAn
Objectiveis a statable learning objective.-
has_assessment()¶ Tests if an assessment is associated with this objective.
Returns: trueif an assessment exists,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
assessment_id¶ Gets the assessment
Idassociated with this learning objective.Returns: the assessment IdReturn type: osid.id.IdRaise: IllegalState–has_assessment()isfalsecompliance: mandatory – This method must be implemented.
-
assessment¶ Gets the assessment associated with this learning objective.
Returns: the assessment Return type: osid.assessment.AssessmentRaise: IllegalState–has_assessment()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
has_knowledge_category()¶ Tests if this objective has a knowledge dimension.
Returns: trueif a knowledge category exists,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
knowledge_category_id¶ Gets the grade
Idassociated with the knowledge dimension.Returns: the grade IdReturn type: osid.id.IdRaise: IllegalState–has_knowledge_category()isfalsecompliance: mandatory – This method must be implemented.
-
knowledge_category¶ Gets the grade associated with the knowledge dimension.
Returns: the grade Return type: osid.grading.GradeRaise: IllegalState–has_knowledge_category()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
has_cognitive_process()¶ Tests if this objective has a cognitive process type.
Returns: trueif a cognitive process exists,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
cognitive_process_id¶ Gets the grade
Idassociated with the cognitive process.Returns: the grade IdReturn type: osid.id.IdRaise: IllegalState–has_cognitive_process()isfalsecompliance: mandatory – This method must be implemented.
-
cognitive_process¶ Gets the grade associated with the cognitive process.
Returns: the grade Return type: osid.grading.GradeRaise: IllegalState–has_cognitive_process()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_objective_record(objective_record_type)¶ Gets the objective bank record corresponding to the given
ObjectiverecordType.This method is used to retrieve an object implementing the requested record. The
objective_record_typemay be theTypereturned inget_record_types()or any of its parents in aTypehierarchy wherehas_record_type(objective_record_type)istrue.Parameters: objective_record_type ( osid.type.Type) – an objective record typeReturns: the objective record Return type: osid.learning.records.ObjectiveRecordRaise: NullArgument–objective_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(objective_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Objective Form¶
-
class
dlkit.learning.objects.ObjectiveForm¶ Bases:
dlkit.osid.objects.OsidObjectForm,dlkit.osid.objects.OsidFederateableFormThis is the form for creating and updating
Objectives.Like all
OsidFormobjects, various data elements may be set here for use in the create and update methods in theObjectiveAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.-
assessment_metadata¶ Gets the metadata for an assessment.
Returns: metadata for the assessment Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
assessment¶
-
knowledge_category_metadata¶ Gets the metadata for a knowledge category.
Returns: metadata for the knowledge category Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
knowledge_category¶
-
cognitive_process_metadata¶ Gets the metadata for a cognitive process.
Returns: metadata for the cognitive process Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
cognitive_process¶
-
get_objective_form_record(objective_record_type)¶ Gets the
ObjectiveFormRecordcorresponding to the given objective recordType.Parameters: objective_record_type ( osid.type.Type) – the objective record typeReturns: the objective form record Return type: osid.learning.records.ObjectiveFormRecordRaise: NullArgument–objective_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(objective_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Objective List¶
-
class
dlkit.learning.objects.ObjectiveList¶ Bases:
dlkit.osid.objects.OsidListLike all
OsidLists,ObjectiveListprovides a means for accessingObjectiveelements sequentially either one at a time or many at a time.Examples: while (ol.hasNext()) { Objective objective = ol.getNextObjective(); }
- or
- while (ol.hasNext()) {
- Objective[] objectives = ol.getNextObjectives(ol.available());
}
-
next_objective¶ Gets the next
Objectivein this list.Returns: the next Objectivein this list. Thehas_next()method should be used to test that a nextObjectiveis available before calling this method.Return type: osid.learning.ObjectiveRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_next_objectives(n)¶ Gets the next set of
Objectiveelements in this list which must be less than or equal to the number returned fromavailable().Parameters: n ( cardinal) – the number ofObjectiveelements requested which should be less than or equal toavailable()Returns: an array of Objectiveelements.The length of the array is less than or equal to the number specified.Return type: osid.learning.ObjectiveRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
Objective Node¶
-
class
dlkit.learning.objects.ObjectiveNode¶ Bases:
dlkit.osid.objects.OsidNodeThis interface is a container for a partial hierarchy retrieval.
The number of hierarchy levels traversable through this interface depend on the number of levels requested in the
ObjectiveHierarchySession.-
objective¶ Gets the
Objectiveat this node.Returns: the objective represented by this node Return type: osid.learning.Objectivecompliance: mandatory – This method must be implemented.
-
parent_objective_nodes¶ Gets the parents of this objective.
Returns: the parents of the idReturn type: osid.learning.ObjectiveNodeListcompliance: mandatory – This method must be implemented.
-
child_objective_nodes¶ Gets the children of this objective.
Returns: the children of this objective Return type: osid.learning.ObjectiveNodeListcompliance: mandatory – This method must be implemented.
-
Objective Node List¶
-
class
dlkit.learning.objects.ObjectiveNodeList¶ Bases:
dlkit.osid.objects.OsidListLike all
OsidLists,ObjectiveNodeListprovides a means for accessingObjectiveNodeelements sequentially either one at a time or many at a time.Examples: while (onl.hasNext()) { ObjectiveNode node = onl.getNextObjectiveNode(); }
- or
- while (onl.hasNext()) {
- ObjectiveNode[] nodes = onl.getNextObjectiveNodes(onl.available());
}
-
next_objective_node¶ Gets the next
ObjectiveNodein this list.Returns: the next ObjectiveNodein this list. Thehas_next()method should be used to test that a nextObjectiveNodeis available before calling this method.Return type: osid.learning.ObjectiveNodeRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_next_objective_nodes(n)¶ Gets the next set of
ObjectiveNodeelements in this list which must be less than or equal to the number returned fromavailable().Parameters: n ( cardinal) – the number ofObjectiveNodeelements requested which should be less than or equal toavailable()Returns: an array of ObjectiveNodeelements.The length of the array is less than or equal to the number specified.Return type: osid.learning.ObjectiveNodeRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
Activity¶
-
class
dlkit.learning.objects.Activity¶ Bases:
dlkit.osid.objects.OsidObject,dlkit.osid.markers.SubjugateableAn
Activityrepresents learning material or other learning activities to meet an objective.An Activity has may relate to a set of
Assstsfor self learning, recommendedCoursesto take, or a learningAssessment. The learningAssessmentdiffers from theObjectiveAssessmentin that the latter used to test for proficiency in theObjective.Generally, an
Activityshould focus on one of assets, courses, assessments, or some other specific activity related to the objective described or related in theActivityRecord.-
objective_id¶ Gets the
Idof the related objective.Returns: the objective IdReturn type: osid.id.Idcompliance: mandatory – This method must be implemented.
-
objective¶ Gets the related objective.
Returns: the related objective Return type: osid.learning.ObjectiveRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
is_asset_based_activity()¶ Tests if this is an asset based activity.
Returns: trueif this activity is based on assets,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
asset_ids¶ Gets the
Idsof any assets associated with this activity.Returns: list of asset IdsReturn type: osid.id.IdListRaise: IllegalState–is_asset_based_activity()isfalsecompliance: mandatory – This method must be implemented.
-
assets¶ Gets any assets associated with this activity.
Returns: list of assets Return type: osid.repository.AssetListRaise: IllegalState–is_asset_based_activity()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
is_course_based_activity()¶ Tests if this is a course based activity.
Returns: trueif this activity is based on courses,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
course_ids¶ Gets the
Idsof any courses associated with this activity.Returns: list of course IdsReturn type: osid.id.IdListRaise: IllegalState–is_course_based_activity()isfalsecompliance: mandatory – This method must be implemented.
-
courses¶ Gets any courses associated with this activity.
Returns: list of courses Return type: osid.course.CourseListRaise: IllegalState–is_course_based_activity()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
is_assessment_based_activity()¶ Tests if this is an assessment based activity.
These assessments are for learning the objective and not for assessing prodiciency in the objective.
Returns: trueif this activity is based on assessments,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
assessment_ids¶ Gets the
Idsof any assessments associated with this activity.Returns: list of assessment IdsReturn type: osid.id.IdListRaise: IllegalState–is_assessment_based_activity()isfalsecompliance: mandatory – This method must be implemented.
-
assessments¶ Gets any assessments associated with this activity.
Returns: list of assessments Return type: osid.assessment.AssessmentListRaise: IllegalState–is_assessment_based_activity()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_activity_record(activity_record_type)¶ Gets the activity record corresponding to the given
ActivityrecordType.This method is used to retrieve an object implementing the requested record. The
activity_record_typemay be theTypereturned inget_record_types()or any of its parents in aTypehierarchy wherehas_record_type(activity_record_type)istrue.Parameters: activity_record_type ( osid.type.Type) – the type of the record to retrieveReturns: the activity record Return type: osid.learning.records.ActivityRecordRaise: NullArgument–activity_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(activity_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Activity Form¶
-
class
dlkit.learning.objects.ActivityForm¶ Bases:
dlkit.osid.objects.OsidObjectForm,dlkit.osid.objects.OsidSubjugateableFormThis is the form for creating and updating
Activities.Like all
OsidFormobjects, various data elements may be set here for use in the create and update methods in theActivityAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.-
assets_metadata¶ Gets the metadata for the assets.
Returns: metadata for the assets Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
assets¶
-
courses_metadata¶ Gets the metadata for the courses.
Returns: metadata for the courses Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
courses¶
-
assessments_metadata¶ Gets the metadata for the assessments.
Returns: metadata for the assessments Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
assessments¶
-
get_activity_form_record(activity_record_type)¶ Gets the
ActivityFormRecordcorresponding to the given activity recordType.Parameters: activity_record_type ( osid.type.Type) – the activity record typeReturns: the activity form record Return type: osid.learning.records.ActivityFormRecordRaise: NullArgument–activity_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(activity_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Activity List¶
-
class
dlkit.learning.objects.ActivityList¶ Bases:
dlkit.osid.objects.OsidListLike all
OsidLists,ActivityListprovides a means for accessingActivityelements sequentially either one at a time or many at a time.Examples: while (al.hasNext()) { Activity activity = al.getNextActivity(); }
- or
- while (al.hasNext()) {
- Activity[] activities = al.getNextActivities(al.available());
}
-
next_activity¶ Gets the next
Activityin this list.Returns: the next Activityin this list. Thehas_next()method should be used to test that a nextActivityis available before calling this method.Return type: osid.learning.ActivityRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_next_activities(n)¶ Gets the next set of
Activityelements in this list which must be less than or equal to the number returned fromavailable().Parameters: n ( cardinal) – the number ofActivityelements requested which should be less than or equal toavailable()Returns: an array of Activityelements.The length of the array is less than or equal to the number specified.Return type: osid.learning.ActivityRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
Proficiency¶
-
class
dlkit.learning.objects.Proficiency¶ Bases:
dlkit.osid.objects.OsidRelationshipA
Proficiencyrepresents a competency of a leraning objective.-
resource_id¶ Gets the resource
Idto whom this proficiency applies.Returns: the resource IdReturn type: osid.id.Idcompliance: mandatory – This method must be implemented.
-
resource¶ Gets the resource to whom this proficiency applies.
Returns: the resource Return type: osid.resource.ResourceRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
objective_id¶ Gets the objective
Idto whom this proficiency applies.Returns: the objective IdReturn type: osid.id.Idcompliance: mandatory – This method must be implemented.
-
objective¶ Gets the objective to whom this proficiency applies.
Returns: the objective Return type: osid.learning.ObjectiveRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
completion¶ Gets the completion of this objective as a percentage 0-100.
Returns: the completion Return type: decimalcompliance: mandatory – This method must be implemented.
-
has_level()¶ Tests if a proficiency level is available.
Returns: trueif a level is available,falseotherwiseReturn type: booleancompliance: mandatory – This method must be implemented.
-
level_id¶ Gets the proficiency level expressed as a grade.
Returns: the grade IdReturn type: osid.id.IdRaise: IllegalState–has_level()isfalsecompliance: mandatory – This method must be implemented.
-
level¶ Gets the proficiency level expressed as a grade.
Returns: the grade Return type: osid.grading.GradeRaise: IllegalState–has_level()isfalseRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_proficiency_record(proficiency_record_type)¶ Gets the proficiency record corresponding to the given
ProficiencyrecordType.This method is used to retrieve an object implementing the requested record. The
proficiency_record_typemay be theTypereturned inget_record_types()or any of its parents in aTypehierarchy wherehas_record_type(proficiency_record_type)istrue.Parameters: proficiency_record_type ( osid.type.Type) – the type of proficiency record to retrieveReturns: the proficiency record Return type: osid.learning.records.ProficiencyRecordRaise: NullArgument–proficiency_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(proficiency_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Proficiency Form¶
-
class
dlkit.learning.objects.ProficiencyForm¶ Bases:
dlkit.osid.objects.OsidRelationshipFormThis is the form for creating and updating
Proficiencies.Like all
OsidFormobjects, various data elements may be set here for use in the create and update methods in theProficiencyAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.-
completion_metadata¶ Gets the metadata for completion percentage.
Returns: metadata for the completion percentage Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
completion¶
-
level_metadata¶ Gets the metadata for a level.
Returns: metadata for the grade level Return type: osid.Metadatacompliance: mandatory – This method must be implemented.
-
level¶
-
get_proficiency_form_record(proficiency_record_type)¶ Gets the
ProficiencyFormRecordcorresponding to the given proficiency recordType.Parameters: proficiency_record_type ( osid.type.Type) – a proficiency record typeReturns: the proficiency form record Return type: osid.learning.records.ProficiencyFormRecordRaise: NullArgument–proficiency_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(proficiency_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Proficiency List¶
-
class
dlkit.learning.objects.ProficiencyList¶ Bases:
dlkit.osid.objects.OsidListLike all
OsidLists,ProficiencyListprovides a means for accessingProficiencyelements sequentially either one at a time or many at a time.Examples: while (pl.hasNext()) { Proficiency proficiency = pl.getNextProficiency(); }
- or
- while (pl.hasNext()) {
- Proficiency[] proficiencies = pl.getNextProficiencies(pl.available());
}
-
next_proficiency¶ Gets the next
Proficiencyin this list.Returns: the next Proficiencyin this list. Thehas_next()method should be used to test that a nextProficiencyis available before calling this method.Return type: osid.learning.ProficiencyRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_next_proficiencies(n)¶ Gets the next set of
Proficiencyelements in this list.The specified amount must be less than or equal to the return from
available().Parameters: n ( cardinal) – the number ofProficiencyelements requested which must be less than or equal toavailable()Returns: an array of Proficiencyelements.The length of the array is less than or equal to the number specified.Return type: osid.learning.ProficiencyRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
Objective Bank¶
-
class
dlkit.learning.objects.ObjectiveBank(abc_learning_objects.ObjectiveBank, osid_objects.OsidCatalog)¶ -
:noindex: -
get_objective_bank_record(objective_bank_record_type)¶ Gets the objective bank record corresponding to the given
ObjectiveBankrecordType.This method is used to retrieve an object implementing the requested record. The
objective_bank_record_typemay be theTypereturned inget_record_types()or any of its parents in aTypehierarchy wherehas_record_type(objective_bank_record_type)istrue.Parameters: objective_bank_record_type ( osid.type.Type) – an objective bank record typeReturns: the objective bank record Return type: osid.learning.records.ObjectiveBankRecordRaise: NullArgument–objective_bank_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(objective_bank_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Objective Bank Form¶
-
class
dlkit.learning.objects.ObjectiveBankForm¶ Bases:
dlkit.osid.objects.OsidCatalogFormThis is the form for creating and updating objective banks.
Like all
OsidFormobjects, various data elements may be set here for use in the create and update methods in theObjectiveBankAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.-
get_objective_bank_form_record(objective_bank_record_type)¶ Gets the
ObjectiveBankFormRecordcorresponding to the given objective bank recordType.Parameters: objective_bank_record_type ( osid.type.Type) – an objective bank record typeReturns: the objective bank form record Return type: osid.learning.records.ObjectiveBankFormRecordRaise: NullArgument–objective_bank_record_typeisnullRaise: OperationFailed– unable to complete requestRaise: Unsupported–has_record_type(objective_bank_record_type)isfalsecompliance: mandatory – This method must be implemented.
-
Objective Bank List¶
-
class
dlkit.learning.objects.ObjectiveBankList¶ Bases:
dlkit.osid.objects.OsidListLike all
OsidLists,ObjectiveBankListprovides a means for accessingObjectiveBankelements sequentially either one at a time or many at a time.Examples: while (obl.hasNext()) { ObjectiveBank objectiveBanks = obl.getNextObjectiveBank(); }
- or
- while (obl.hasNext()) {
- ObjectiveBank[] objectivBanks = obl.getNextObjectiveBanks(obl.available());
}
-
next_objective_bank¶ Gets the next
ObjectiveBankin this list.Returns: the next ObjectiveBankin this list. Thehas_next()method should be used to test that a nextObjectiveBankis available before calling this method.Return type: osid.learning.ObjectiveBankRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_next_objective_banks(n)¶ Gets the next set of
ObjectiveBankelements in this list which must be less than or equal to the return fromavailable().Parameters: n ( cardinal) – the number ofObjectiveBankelements requested which must be less than or equal toavailable()Returns: an array of ObjectiveBankelements.The length of the array is less than or equal to the number specified.Return type: osid.learning.ObjectiveBankRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
Objective Bank Node¶
-
class
dlkit.learning.objects.ObjectiveBankNode¶ Bases:
dlkit.osid.objects.OsidNodeThis interface is a container for a partial hierarchy retrieval.
The number of hierarchy levels traversable through this interface depend on the number of levels requested in the
ObjectiveBankHierarchySession.-
objective_bank¶ Gets the
ObjectiveBankat this node.Returns: the objective bank represented by this node Return type: osid.learning.ObjectiveBankcompliance: mandatory – This method must be implemented.
-
parent_objective_bank_nodes¶ Gets the parents of this objective bank.
Returns: the parents of the idReturn type: osid.learning.ObjectiveBankNodeListcompliance: mandatory – This method must be implemented.
-
child_objective_bank_nodes¶ Gets the children of this objective bank.
Returns: the children of this objective bank Return type: osid.learning.ObjectiveBankNodeListcompliance: mandatory – This method must be implemented.
-
Objective Bank Node List¶
-
class
dlkit.learning.objects.ObjectiveBankNodeList¶ Bases:
dlkit.osid.objects.OsidListLike all
OsidLists,ObjectiveBankNodeListprovides a means for accessingObjectiveBankNodeelements sequentially either one at a time or many at a time.Examples: while (obnl.hasNext()) { ObjectiveBankNode node bank = obnl.getNextObjectiveBankNode(); }
- or
- while (obnl.hasNext()) {
- ObjectiveBankNode[] nodes = obnl.getNextObjectiveBankNodes(obnl.available());
}
-
next_objective_bank_node¶ Gets the next
ObjectiveBankNodein this list.Returns: the next ObjectiveBankNodein this list. Thehas_next()method should be used to test that a nextObjectiveBankNodeis available before calling this method.Return type: osid.learning.ObjectiveBankNodeRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.
-
get_next_objective_bank_nodes(n)¶ Gets the next set of
ObjectiveBankNodeelements in this list which must be less than or equal to the return fromavailable().Parameters: n ( cardinal) – the number ofObjectiveBankNodeelements requested which must be less than or equal toavailable()Returns: an array of ObjectiveBankNodeelements.The length of the array is less than or equal to the number specified.Return type: osid.learning.ObjectiveBankNodeRaise: IllegalState– no more elements available in this listRaise: OperationFailed– unable to complete requestcompliance: mandatory – This method must be implemented.