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

compliance: mandatory – This method must be implemented.

assessment_id

Gets the assessment Id associated with this learning objective.

Returns:the assessment Id
Return type:osid.id.Id
Raise:IllegalStatehas_assessment() is false

compliance: mandatory – This method must be implemented.

assessment

Gets the assessment associated with this learning objective.

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

compliance: mandatory – This method must be implemented.

has_knowledge_category()

Tests if this objective has a knowledge dimension.

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

compliance: mandatory – This method must be implemented.

knowledge_category_id

Gets the grade Id associated with the knowledge dimension.

Returns:the grade Id
Return type:osid.id.Id
Raise:IllegalStatehas_knowledge_category() is false

compliance: mandatory – This method must be implemented.

knowledge_category

Gets the grade associated with the knowledge dimension.

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

compliance: mandatory – This method must be implemented.

has_cognitive_process()

Tests if this objective has a cognitive process type.

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

compliance: mandatory – This method must be implemented.

cognitive_process_id

Gets the grade Id associated with the cognitive process.

Returns:the grade Id
Return type:osid.id.Id
Raise:IllegalStatehas_cognitive_process() is false

compliance: mandatory – This method must be implemented.

cognitive_process

Gets the grade associated with the cognitive process.

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

compliance: mandatory – This method must be implemented.

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:NullArgumentobjective_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(objective_record_type) is false

compliance: mandatory – This method must be implemented.

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

compliance: 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.Metadata

compliance: 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.Metadata

compliance: mandatory – This method must be implemented.

cognitive_process
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:NullArgumentobjective_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(objective_record_type) is false

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

Objective Node

class dlkit.learning.objects.ObjectiveNode

Bases: dlkit.osid.objects.OsidNode

This 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 Objective at this node.

Returns:the objective represented by this node
Return type:osid.learning.Objective

compliance: mandatory – This method must be implemented.

parent_objective_nodes

Gets the parents of this objective.

Returns:the parents of the id
Return type:osid.learning.ObjectiveNodeList

compliance: 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.ObjectiveNodeList

compliance: mandatory – This method must be implemented.

Objective Node List

class dlkit.learning.objects.ObjectiveNodeList

Bases: dlkit.osid.objects.OsidList

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

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

compliance: mandatory – This method must be implemented.

get_next_objective_nodes(n)

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

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

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

objective

Gets the related objective.

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

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

asset_ids

Gets the Ids of any assets associated with this activity.

Returns:list of asset Ids
Return type:osid.id.IdList
Raise:IllegalStateis_asset_based_activity() is false

compliance: mandatory – This method must be implemented.

assets

Gets any assets associated with this activity.

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

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

course_ids

Gets the Ids of any courses associated with this activity.

Returns:list of course Ids
Return type:osid.id.IdList
Raise:IllegalStateis_course_based_activity() is false

compliance: mandatory – This method must be implemented.

courses

Gets any courses associated with this activity.

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

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

compliance: mandatory – This method must be implemented.

assessment_ids

Gets the Ids of any assessments associated with this activity.

Returns:list of assessment Ids
Return type:osid.id.IdList
Raise:IllegalStateis_assessment_based_activity() is false

compliance: mandatory – This method must be implemented.

assessments

Gets any assessments associated with this activity.

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

compliance: mandatory – This method must be implemented.

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:NullArgumentactivity_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(activity_record_type) is false

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

assets
courses_metadata

Gets the metadata for the courses.

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

compliance: mandatory – This method must be implemented.

courses
assessments_metadata

Gets the metadata for the assessments.

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

compliance: mandatory – This method must be implemented.

assessments
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:NullArgumentactivity_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(activity_record_type) is false

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

Proficiency

class dlkit.learning.objects.Proficiency

Bases: dlkit.osid.objects.OsidRelationship

A Proficiency represents a competency of a leraning objective.

resource_id

Gets the resource Id to whom this proficiency applies.

Returns:the resource Id
Return type:osid.id.Id

compliance: mandatory – This method must be implemented.

resource

Gets the resource to whom this proficiency applies.

Returns:the resource
Return type:osid.resource.Resource
Raise:OperationFailed – unable to complete request

compliance: mandatory – This method must be implemented.

objective_id

Gets the objective Id to whom this proficiency applies.

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

compliance: mandatory – This method must be implemented.

objective

Gets the objective to whom this proficiency applies.

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

compliance: mandatory – This method must be implemented.

completion

Gets the completion of this objective as a percentage 0-100.

Returns:the completion
Return type:decimal

compliance: mandatory – This method must be implemented.

has_level()

Tests if a proficiency level is available.

Returns:true if a level is available, false otherwise
Return type:boolean

compliance: mandatory – This method must be implemented.

level_id

Gets the proficiency level expressed as a grade.

Returns:the grade Id
Return type:osid.id.Id
Raise:IllegalStatehas_level() is false

compliance: mandatory – This method must be implemented.

level

Gets the proficiency level expressed as a grade.

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

compliance: mandatory – This method must be implemented.

get_proficiency_record(proficiency_record_type)

Gets the proficiency record corresponding to the given Proficiency record Type.

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

Parameters:proficiency_record_type (osid.type.Type) – the type of proficiency record to retrieve
Returns:the proficiency record
Return type:osid.learning.records.ProficiencyRecord
Raise:NullArgumentproficiency_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(proficiency_record_type) is false

compliance: mandatory – This method must be implemented.

Proficiency Form

class dlkit.learning.objects.ProficiencyForm

Bases: dlkit.osid.objects.OsidRelationshipForm

This is the form for creating and updating Proficiencies.

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

compliance: mandatory – This method must be implemented.

completion
level_metadata

Gets the metadata for a level.

Returns:metadata for the grade level
Return type:osid.Metadata

compliance: mandatory – This method must be implemented.

level
get_proficiency_form_record(proficiency_record_type)

Gets the ProficiencyFormRecord corresponding to the given proficiency record Type.

Parameters:proficiency_record_type (osid.type.Type) – a proficiency record type
Returns:the proficiency form record
Return type:osid.learning.records.ProficiencyFormRecord
Raise:NullArgumentproficiency_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(proficiency_record_type) is false

compliance: mandatory – This method must be implemented.

Proficiency List

class dlkit.learning.objects.ProficiencyList

Bases: dlkit.osid.objects.OsidList

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

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

compliance: mandatory – This method must be implemented.

get_next_proficiencies(n)

Gets the next set of Proficiency elements in this list.

The specified amount must be less than or equal to the return from available().

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

compliance: 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 ObjectiveBank record Type.

This method is used to retrieve an object implementing the requested record. The objective_bank_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_bank_record_type) is true .

Parameters:objective_bank_record_type (osid.type.Type) – an objective bank record type
Returns:the objective bank record
Return type:osid.learning.records.ObjectiveBankRecord
Raise:NullArgumentobjective_bank_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(objective_bank_record_type) is false

compliance: mandatory – This method must be implemented.

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:NullArgumentobjective_bank_record_type is null
Raise:OperationFailed – unable to complete request
Raise:Unsupportedhas_record_type(objective_bank_record_type) is false

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

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

compliance: mandatory – This method must be implemented.

Objective Bank Node

class dlkit.learning.objects.ObjectiveBankNode

Bases: dlkit.osid.objects.OsidNode

This 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 ObjectiveBank at this node.

Returns:the objective bank represented by this node
Return type:osid.learning.ObjectiveBank

compliance: mandatory – This method must be implemented.

parent_objective_bank_nodes

Gets the parents of this objective bank.

Returns:the parents of the id
Return type:osid.learning.ObjectiveBankNodeList

compliance: 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.ObjectiveBankNodeList

compliance: mandatory – This method must be implemented.

Objective Bank Node List

class dlkit.learning.objects.ObjectiveBankNodeList

Bases: dlkit.osid.objects.OsidList

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

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

compliance: mandatory – This method must be implemented.

get_next_objective_bank_nodes(n)

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

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

compliance: mandatory – This method must be implemented.