Objects¶

Objective¶

class dlkit.learning.objects.Objective¶

Bases: dlkit.osid.objects.OsidObject, dlkit.osid.markers.Federateable

An Objective is a statable learning objective.

has_assessment()¶

Tests if an assessment is associated with this objective.

Returns:	`true` if an assessment exists, `false` otherwise
Return type:	`boolean`

assessment_id¶

Gets the assessment Id associated with this learning objective.

Returns:	the assessment `Id`
Return type:	`osid.id.Id`
Raise:	`IllegalState` – `has_assessment()` is `false`

assessment¶

Gets the assessment associated with this learning objective.

Returns:	the assessment
Return type:	`osid.assessment.Assessment`
Raise:	`IllegalState` – `has_assessment()` is `false`
Raise:	`OperationFailed` – unable to complete request

has_knowledge_category()¶

Tests if this objective has a knowledge dimension.

Returns:	`true` if a knowledge category exists, `false` otherwise
Return type:	`boolean`

knowledge_category_id¶

Gets the grade Id associated with the knowledge dimension.

Returns:	the grade `Id`
Return type:	`osid.id.Id`
Raise:	`IllegalState` – `has_knowledge_category()` is `false`

knowledge_category¶

Gets the grade associated with the knowledge dimension.

Returns:	the grade
Return type:	`osid.grading.Grade`
Raise:	`IllegalState` – `has_knowledge_category()` is `false`
Raise:	`OperationFailed` – unable to complete request

has_cognitive_process()¶

Tests if this objective has a cognitive process type.

Returns:	`true` if a cognitive process exists, `false` otherwise
Return type:	`boolean`

cognitive_process_id¶

Gets the grade Id associated with the cognitive process.

Returns:	the grade `Id`
Return type:	`osid.id.Id`
Raise:	`IllegalState` – `has_cognitive_process()` is `false`

cognitive_process¶

Gets the grade associated with the cognitive process.

Returns:	the grade
Return type:	`osid.grading.Grade`
Raise:	`IllegalState` – `has_cognitive_process()` is `false`
Raise:	`OperationFailed` – unable to complete request

get_objective_record(objective_record_type)¶

Gets the objective bank record corresponding to the given Objective record Type.

This method is used to retrieve an object implementing the requested record. The objective_record_type may be the Type returned in get_record_types() or any of its parents in a Type hierarchy where has_record_type(objective_record_type) is true .

Parameters:	objective_record_type (`osid.type.Type`) – an objective record type
Returns:	the objective record
Return type:	`osid.learning.records.ObjectiveRecord`
Raise:	`NullArgument` – `objective_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(objective_record_type)` is `false`

Objective Form¶

class dlkit.learning.objects.ObjectiveForm¶

Bases: dlkit.osid.objects.OsidObjectForm, dlkit.osid.objects.OsidFederateableForm

This is the form for creating and updating Objectives.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ObjectiveAdminSession. 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.Metadata`

assessment¶

Sets the assessment.

Parameters:	assessment_id (`osid.id.Id`) – the new assessment
Raise:	`InvalidArgument` – `assessment_id` is invalid
Raise:	`NoAccess` – `assessment_id` cannot be modified
Raise:	`NullArgument` – `assessment_id` is `null`

knowledge_category_metadata¶

Gets the metadata for a knowledge category.

Returns:	metadata for the knowledge category
Return type:	`osid.Metadata`

knowledge_category¶

Sets the knowledge category.

Parameters:	grade_id (`osid.id.Id`) – the new knowledge category
Raise:	`InvalidArgument` – `grade_id` is invalid
Raise:	`NoAccess` – `grade_id` cannot be modified
Raise:	`NullArgument` – `grade_id` is `null`

cognitive_process_metadata¶

Gets the metadata for a cognitive process.

Returns:	metadata for the cognitive process
Return type:	`osid.Metadata`

cognitive_process¶

Sets the cognitive process.

Parameters:	grade_id (`osid.id.Id`) – the new cognitive process
Raise:	`InvalidArgument` – `grade_id` is invalid
Raise:	`NoAccess` – `grade_id` cannot be modified
Raise:	`NullArgument` – `grade_id` is `null`

get_objective_form_record(objective_record_type)¶

Gets the ObjectiveFormRecord corresponding to the given objective record Type.

Parameters:	objective_record_type (`osid.type.Type`) – the objective record type
Returns:	the objective form record
Return type:	`osid.learning.records.ObjectiveFormRecord`
Raise:	`NullArgument` – `objective_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(objective_record_type)` is `false`

Objective List¶

class dlkit.learning.objects.ObjectiveList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, ObjectiveList provides a means for accessing Objective elements 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 Objective in this list.

Returns:	the next `Objective` in this list. The `has_next()` method should be used to test that a next `Objective` is available before calling this method.
Return type:	`osid.learning.Objective`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

get_next_objectives(n)¶

Gets the next set of Objective elements in this list which must be less than or equal to the number returned from available().

Parameters:	n (`cardinal`) – the number of `Objective` elements requested which should be less than or equal to `available()`
Returns:	an array of `Objective` elements.The length of the array is less than or equal to the number specified.
Return type:	`osid.learning.Objective`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

Activity¶

class dlkit.learning.objects.Activity¶

Bases: dlkit.osid.objects.OsidObject, dlkit.osid.markers.Subjugateable

An Activity represents learning material or other learning activities to meet an objective.

An Activity has may relate to a set of Asssts for self learning, recommended Courses to take, or a learning Assessment. The learning Assessment differs from the Objective Assessment in that the latter used to test for proficiency in the Objective.

Generally, an Activity should focus on one of assets, courses, assessments, or some other specific activity related to the objective described or related in the ActivityRecord.

objective_id¶

Gets the Id of the related objective.

Returns:	the objective `Id`
Return type:	`osid.id.Id`

objective¶

Gets the related objective.

Returns:	the related objective
Return type:	`osid.learning.Objective`
Raise:	`OperationFailed` – unable to complete request

is_asset_based_activity()¶

Tests if this is an asset based activity.

Returns:	`true` if this activity is based on assets, `false` otherwise
Return type:	`boolean`

asset_ids¶

Gets the Ids of any assets associated with this activity.

Returns:	list of asset `Ids`
Return type:	`osid.id.IdList`
Raise:	`IllegalState` – `is_asset_based_activity()` is `false`

assets¶

Gets any assets associated with this activity.

Returns:	list of assets
Return type:	`osid.repository.AssetList`
Raise:	`IllegalState` – `is_asset_based_activity()` is `false`
Raise:	`OperationFailed` – unable to complete request

is_course_based_activity()¶

Tests if this is a course based activity.

Returns:	`true` if this activity is based on courses, `false` otherwise
Return type:	`boolean`

course_ids¶

Gets the Ids of any courses associated with this activity.

Returns:	list of course `Ids`
Return type:	`osid.id.IdList`
Raise:	`IllegalState` – `is_course_based_activity()` is `false`

courses¶

Gets any courses associated with this activity.

Returns:	list of courses
Return type:	`osid.course.CourseList`
Raise:	`IllegalState` – `is_course_based_activity()` is `false`
Raise:	`OperationFailed` – unable to complete request

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:	`true` if this activity is based on assessments, `false` otherwise
Return type:	`boolean`

assessment_ids¶

Gets the Ids of any assessments associated with this activity.

Returns:	list of assessment `Ids`
Return type:	`osid.id.IdList`
Raise:	`IllegalState` – `is_assessment_based_activity()` is `false`

assessments¶

Gets any assessments associated with this activity.

Returns:	list of assessments
Return type:	`osid.assessment.AssessmentList`
Raise:	`IllegalState` – `is_assessment_based_activity()` is `false`
Raise:	`OperationFailed` – unable to complete request

get_activity_record(activity_record_type)¶

Gets the activity record corresponding to the given Activity record Type.

This method is used to retrieve an object implementing the requested record. The activity_record_type may be the Type returned in get_record_types() or any of its parents in a Type hierarchy where has_record_type(activity_record_type) is true .

Parameters:	activity_record_type (`osid.type.Type`) – the type of the record to retrieve
Returns:	the activity record
Return type:	`osid.learning.records.ActivityRecord`
Raise:	`NullArgument` – `activity_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(activity_record_type)` is `false`

Activity Form¶

class dlkit.learning.objects.ActivityForm¶

Bases: dlkit.osid.objects.OsidObjectForm, dlkit.osid.objects.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.

assets_metadata¶

Gets the metadata for the assets.

Returns:	metadata for the assets
Return type:	`osid.Metadata`

assets¶

Sets the assets.

Parameters:	asset_ids (`osid.id.Id[]`) – the asset `Ids`
Raise:	`InvalidArgument` – `asset_ids` is invalid
Raise:	`NullArgument` – `asset_ids` is `null`
Raise:	`NoAccess` – `Metadata.isReadOnly()` is `true`

courses_metadata¶

Gets the metadata for the courses.

Returns:	metadata for the courses
Return type:	`osid.Metadata`

courses¶

Sets the courses.

Parameters:	course_ids (`osid.id.Id[]`) – the course `Ids`
Raise:	`InvalidArgument` – `course_ids` is invalid
Raise:	`NullArgument` – `course_ids` is `null`
Raise:	`NoAccess` – `Metadata.isReadOnly()` is `true`

assessments_metadata¶

Gets the metadata for the assessments.

Returns:	metadata for the assessments
Return type:	`osid.Metadata`

assessments¶

Sets the assessments.

Parameters:	assessment_ids (`osid.id.Id[]`) – the assessment `Ids`
Raise:	`InvalidArgument` – `assessment_ids` is invalid
Raise:	`NullArgument` – `assessment_ids` is `null`
Raise:	`NoAccess` – `Metadata.isReadOnly()` is `true`

get_activity_form_record(activity_record_type)¶

Gets the ActivityFormRecord corresponding to the given activity record Type.

Parameters:	activity_record_type (`osid.type.Type`) – the activity record type
Returns:	the activity form record
Return type:	`osid.learning.records.ActivityFormRecord`
Raise:	`NullArgument` – `activity_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(activity_record_type)` is `false`

Activity List¶

class dlkit.learning.objects.ActivityList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, ActivityList provides a means for accessing Activity elements 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 Activity in this list.

Returns:	the next `Activity` in this list. The `has_next()` method should be used to test that a next `Activity` is available before calling this method.
Return type:	`osid.learning.Activity`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

get_next_activities(n)¶

Gets the next set of Activity elements in this list which must be less than or equal to the number returned from available().

Parameters:	n (`cardinal`) – the number of `Activity` elements requested which should be less than or equal to `available()`
Returns:	an array of `Activity` elements.The length of the array is less than or equal to the number specified.
Return type:	`osid.learning.Activity`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

Objective Bank Form¶

class dlkit.learning.objects.ObjectiveBankForm¶

Bases: dlkit.osid.objects.OsidCatalogForm

This is the form for creating and updating objective banks.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ObjectiveBankAdminSession. 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 ObjectiveBankFormRecord corresponding to the given objective bank record Type.

Parameters:	objective_bank_record_type (`osid.type.Type`) – an objective bank record type
Returns:	the objective bank form record
Return type:	`osid.learning.records.ObjectiveBankFormRecord`
Raise:	`NullArgument` – `objective_bank_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(objective_bank_record_type)` is `false`

Objective Bank List¶

class dlkit.learning.objects.ObjectiveBankList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, ObjectiveBankList provides a means for accessing ObjectiveBank elements 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 ObjectiveBank in this list.

Returns:	the next `ObjectiveBank` in this list. The `has_next()` method should be used to test that a next `ObjectiveBank` is available before calling this method.
Return type:	`osid.learning.ObjectiveBank`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

get_next_objective_banks(n)¶

Gets the next set of ObjectiveBank elements in this list which must be less than or equal to the return from available().

Parameters:	n (`cardinal`) – the number of `ObjectiveBank` elements requested which must be less than or equal to `available()`
Returns:	an array of `ObjectiveBank` elements.The length of the array is less than or equal to the number specified.
Return type:	`osid.learning.ObjectiveBank`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request