Objects¶

Question¶

class dlkit.assessment.objects.Question¶

Bases: dlkit.osid.objects.OsidObject

A Question represents the question portion of an assessment item.

Like all OSID objects, a Question is identified by its Id and any persisted references should use the Id.

get_question_record(question_record_type)¶

Gets the item record corresponding to the given Question record Type.

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

Parameters:	question_record_type (`osid.type.Type`) – the type of the record to retrieve
Returns:	the question record
Return type:	`osid.assessment.records.QuestionRecord`
Raise:	`NullArgument` – `question_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(question_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Question Form¶

class dlkit.assessment.objects.QuestionForm¶

Bases: dlkit.osid.objects.OsidObjectForm

This is the form for creating and updating Questions.

get_question_form_record(question_record_type)¶

Gets the QuestionFormRecord corresponding to the given question record Type.

Parameters:	question_record_type (`osid.type.Type`) – the question record type
Returns:	the question record
Return type:	`osid.assessment.records.QuestionFormRecord`
Raise:	`NullArgument` – `question_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(question_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Question List¶

class dlkit.assessment.objects.QuestionList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, QuestionList provides a means for accessing Question elements sequentially either one at a time or many at a time.

Examples: while (ql.hasNext()) { Question question = ql.getNextQuestion(); }

or

while (ql.hasNext()) {: Question[] question = al.getNextQuestions(ql.available());

}

next_question¶

Gets the next Question in this list.

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

compliance: mandatory – This method must be implemented.

get_next_questions(n)¶

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

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

compliance: mandatory – This method must be implemented.

Answer¶

class dlkit.assessment.objects.Answer¶

Bases: dlkit.osid.objects.OsidObject

An Answer represents the question portion of an assessment item.

Like all OSID objects, an Answer is identified by its Id and any persisted references should use the Id.

get_answer_record(answer_record_type)¶

Gets the answer record corresponding to the given Answer record Type.

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

Parameters:	answer_record_type (`osid.type.Type`) – the type of the record to retrieve
Returns:	the answer record
Return type:	`osid.assessment.records.AnswerRecord`
Raise:	`NullArgument` – `answer_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(answer_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Answer Form¶

class dlkit.assessment.objects.AnswerForm¶

Bases: dlkit.osid.objects.OsidObjectForm

This is the form for creating and updating Answers.

get_answer_form_record(answer_record_type)¶

Gets the AnswerFormRecord corresponding to the given answer record Type.

Parameters:	answer_record_type (`osid.type.Type`) – the answer record type
Returns:	the answer record
Return type:	`osid.assessment.records.AnswerFormRecord`
Raise:	`NullArgument` – `answer_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(answer_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Answer List¶

class dlkit.assessment.objects.AnswerList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, AnswerList provides a means for accessing Answer elements sequentially either one at a time or many at a time.

Examples: while (al.hasNext()) { Answer answer = al.getNextAnswer(); }

or

while (al.hasNext()) {: Answer[] answer = al.getNextAnswers(al.available());

}

next_answer¶

Gets the next Answer in this list.

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

compliance: mandatory – This method must be implemented.

get_next_answers(n)¶

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

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

compliance: mandatory – This method must be implemented.

Item¶

class dlkit.assessment.objects.Item¶

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

An Item represents an individual assessment item such as a question.

Like all OSID objects, a Item is identified by its Id and any persisted references should use the Id.

An Item is composed of a Question and an Answer.

learning_objective_ids¶

Gets the Ids of any Objectives corresponding to this item.

Returns:	the learning objective `Ids`
Return type:	`osid.id.IdList`

compliance: mandatory – This method must be implemented.

learning_objectives¶

Gets the any Objectives corresponding to this item.

Returns:	the learning objectives
Return type:	`osid.learning.ObjectiveList`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

question_id¶

Gets the Id of the Question.

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

compliance: mandatory – This method must be implemented.

question¶

Gets the question.

Returns:	the question
Return type:	`osid.assessment.Question`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

answer_ids¶

Gets the Ids of the answers.

Questions may have more than one acceptable answer.

Returns:	the answer `Ids`
Return type:	`osid.id.IdList`

compliance: mandatory – This method must be implemented.

answers¶

Gets the answers.

Returns:	the answers
Return type:	`osid.assessment.AnswerList`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

get_item_record(item_record_type)¶

Gets the item record corresponding to the given Item record Type.

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

Parameters:	item_record_type (`osid.type.Type`) – the type of the record to retrieve
Returns:	the item record
Return type:	`osid.assessment.records.ItemRecord`
Raise:	`NullArgument` – `item_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(item_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Item Form¶

class dlkit.assessment.objects.ItemForm¶

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

This is the form for creating and updating Items.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ItemAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

learning_objectives_metadata¶

Gets the metadata for learning objectives.

Returns:	metadata for the learning objectives
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

learning_objectives¶

get_item_form_record(item_record_type)¶

Gets the ItemnFormRecord corresponding to the given item record Type.

Parameters:	item_record_type (`osid.type.Type`) – the item record type
Returns:	the item record
Return type:	`osid.assessment.records.ItemFormRecord`
Raise:	`NullArgument` – `item_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(item_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Item List¶

class dlkit.assessment.objects.ItemList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, ItemList provides a means for accessing Item elements sequentially either one at a time or many at a time.

Examples: while (il.hasNext()) { Item item = il.getNextItem(); }

or

while (il.hasNext()) {: Item[] items = il.getNextItems(il.available());

}

next_item¶

Gets the next Item in this list.

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

compliance: mandatory – This method must be implemented.

get_next_items(n)¶

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

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

compliance: mandatory – This method must be implemented.

Assessment¶

class dlkit.assessment.objects.Assessment¶

Bases: dlkit.osid.objects.OsidObject

An Assessment represents a sequence of assessment items.

Like all OSID objects, an Assessment is identified by its Id and any persisted references should use the Id.

An Assessment may have an accompanying rubric used for assessing performance. The rubric assessment is established canonically in this Assessment.

level_id¶

Gets the Id of a Grade corresponding to the assessment difficulty.

Returns:	a grade `Id`
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

level¶

Gets the Grade corresponding to the assessment difficulty.

Returns:	the level
Return type:	`osid.grading.Grade`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

has_rubric()¶

Tests if a rubric assessment is associated with this assessment.

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

compliance: mandatory – This method must be implemented.

rubric_id¶

Gets the Id of the rubric.

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

compliance: mandatory – This method must be implemented.

rubric¶

Gets the rubric.

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

compliance: mandatory – This method must be implemented.

get_assessment_record(assessment_record_type)¶

Gets the assessment record corresponding to the given Assessment record Type.

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

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

compliance: mandatory – This method must be implemented.

Assessment Form¶

class dlkit.assessment.objects.AssessmentForm¶

Bases: dlkit.osid.objects.OsidObjectForm

This is the form for creating and updating Assessments.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AssessmentAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

level_metadata¶

Gets the metadata for a grade level.

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

compliance: mandatory – This method must be implemented.

level¶

rubric_metadata¶

Gets the metadata for a rubric assessment.

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

compliance: mandatory – This method must be implemented.

rubric¶

get_assessment_form_record(assessment_record_type)¶

Gets the AssessmentFormRecord corresponding to the given assessment record Type.

Parameters:	assessment_record_type (`osid.type.Type`) – the assessment record type
Returns:	the assessment record
Return type:	`osid.assessment.records.AssessmentFormRecord`
Raise:	`NullArgument` – `assessment_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(assessment_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Assessment List¶

class dlkit.assessment.objects.AssessmentList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, AssessmentList provides a means for accessing Assessment elements sequentially either one at a time or many at a time.

Examples: while (al.hasNext()) { Assessment assessment = al.getNextAssessment(); }

or

while (al.hasNext()) {: Assessment[] assessments = al.hetNextAssessments(al.available());

}

next_assessment¶

Gets the next Assessment in this list.

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

compliance: mandatory – This method must be implemented.

get_next_assessments(n)¶

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

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

compliance: mandatory – This method must be implemented.

Assessment Offered¶

class dlkit.assessment.objects.AssessmentOffered¶

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

An AssessmentOffered represents a sequence of assessment items.

Like all OSID objects, an AssessmentOffered is identified by its Id and any persisted references should use the Id.

assessment_id¶

Gets the assessment Id corresponding to this assessment offering.

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

compliance: mandatory – This method must be implemented.

assessment¶

Gets the assessment corresponding to this assessment offereng.

Returns:	the assessment
Return type:	`osid.assessment.Assessment`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

level_id¶

Gets the Id of a Grade corresponding to the assessment difficulty.

Returns:	a grade id
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

level¶

Gets the Grade corresponding to the assessment difficulty.

Returns:	the level
Return type:	`osid.grading.Grade`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

are_items_sequential()¶

Tests if the items or parts in this assessment are taken sequentially.

Returns:	`true` if the items are taken sequentially, `false` if the items can be skipped and revisited
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

are_items_shuffled()¶

Tests if the items or parts appear in a random order.

Returns:	`true` if the items appear in a random order, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

has_start_time()¶

Tests if there is a fixed start time for this assessment.

Returns:	`true` if there is a fixed start time, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

start_time¶

Gets the start time for this assessment.

Returns:	the designated start time
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – `has_start_time()` is `false`

compliance: mandatory – This method must be implemented.

has_deadline()¶

Tests if there is a fixed end time for this assessment.

Returns:	`true` if there is a fixed end time, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

deadline¶

Gets the end time for this assessment.

Returns:	the designated end time
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – `has_deadline()` is `false`

compliance: mandatory – This method must be implemented.

has_duration()¶

Tests if there is a fixed duration for this assessment.

Returns:	`true` if there is a fixed duration, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

duration¶

Gets the duration for this assessment.

Returns:	the duration
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – `has_duration()` is `false`

compliance: mandatory – This method must be implemented.

is_scored()¶

Tests if this assessment will be scored.

Returns:	`true` if this assessment will be scored `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

score_system_id¶

Gets the grade system Id for the score.

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

compliance: mandatory – This method must be implemented.

score_system¶

Gets the grade system for the score.

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

compliance: mandatory – This method must be implemented.

is_graded()¶

Tests if this assessment will be graded.

Returns:	`true` if this assessment will be graded, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

grade_system_id¶

Gets the grade system Id for the grade.

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

compliance: mandatory – This method must be implemented.

grade_system¶

Gets the grade system for the grade.

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

compliance: mandatory – This method must be implemented.

has_rubric()¶

Tests if a rubric assessment is associated with this assessment.

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

compliance: mandatory – This method must be implemented.

rubric_id¶

Gets the Id of the rubric.

Returns:	an assessment offered `Id`
Return type:	`osid.id.Id`
Raise:	`IllegalState` – `has_rubric()` is `false`

compliance: mandatory – This method must be implemented.

rubric¶

Gets the rubric.

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

compliance: mandatory – This method must be implemented.

get_assessment_offered_record(assessment_taken_record_type)¶

Gets the assessment offered record corresponding to the given AssessmentOffered record Type.

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

Parameters:	assessment_taken_record_type (`osid.type.Type`) – an assessment offered record type
Returns:	the assessment offered record
Return type:	`osid.assessment.records.AssessmentOfferedRecord`
Raise:	`NullArgument` – `assessment_offered_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(assessment_offered_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Assessment Offered Form¶

class dlkit.assessment.objects.AssessmentOfferedForm¶

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

This is the form for creating and updating an AssessmentOffered.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AssessmentOfferedAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

level_metadata¶

Gets the metadata for a grade level.

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

compliance: mandatory – This method must be implemented.

level¶

items_sequential_metadata¶

Gets the metadata for sequential operation.

Returns:	metadata for the sequential flag
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

items_sequential¶

items_shuffled_metadata¶

Gets the metadata for shuffling items.

Returns:	metadata for the shuffled flag
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

items_shuffled¶

start_time_metadata¶

Gets the metadata for the assessment start time.

Returns:	metadata for the start time
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

start_time¶

deadline_metadata¶

Gets the metadata for the assessment deadline.

Returns:	metadata for the end time
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

deadline¶

duration_metadata¶

Gets the metadata for the assessment duration.

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

compliance: mandatory – This method must be implemented.

duration¶

score_system_metadata¶

Gets the metadata for a score system.

Returns:	metadata for the grade system
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

score_system¶

grade_system_metadata¶

Gets the metadata for a grading system.

Returns:	metadata for the grade system
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

grade_system¶

get_assessment_offered_form_record(assessment_offered_record_type)¶

Gets the AssessmentOfferedFormRecord corresponding to the given assessment record Type.

Parameters:	assessment_offered_record_type (`osid.type.Type`) – the assessment offered record type
Returns:	the assessment offered record
Return type:	`osid.assessment.records.AssessmentOfferedFormRecord`
Raise:	`NullArgument` – `assessment_offered_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(assessment_offered_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Assessment Offered List¶

class dlkit.assessment.objects.AssessmentOfferedList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, AssessmentOfferedList provides a means for accessing AssessmentTaken elements sequentially either one at a time or many at a time.

Examples: while (aol.hasNext()) { AssessmentOffered assessment = aol.getNextAssessmentOffered();

or

while (aol.hasNext()) {: AssessmentOffered[] assessments = aol.hetNextAssessmentsOffered(aol.available());

}

next_assessment_offered¶

Gets the next AssessmentOffered in this list.

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

compliance: mandatory – This method must be implemented.

get_next_assessments_offered(n)¶

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

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

compliance: mandatory – This method must be implemented.

Assessment Taken¶

class dlkit.assessment.objects.AssessmentTaken¶

Bases: dlkit.osid.objects.OsidObject

Represents a taken assessment or an assessment in progress.

assessment_offered_id¶

Gets the Id of the AssessmentOffered.

Returns:	the assessment offered `Id`
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

assessment_offered¶

Gets the AssessmentOffered.

Returns:	the assessment offered
Return type:	`osid.assessment.AssessmentOffered`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

taker_id¶

Gets the Id of the resource who took or is taking this assessment.

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

compliance: mandatory – This method must be implemented.

taker¶

Gets the Resource taking this assessment.

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

compliance: mandatory – This method must be implemented.

taking_agent_id¶

Gets the Id of the Agent who took or is taking the assessment.

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

compliance: mandatory – This method must be implemented.

taking_agent¶

Gets the Agent.

Returns:	the agent
Return type:	`osid.authentication.Agent`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

has_started()¶

Tests if this assessment has begun.

Returns:	`true` if the assessment has begun, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

actual_start_time¶

Gets the time this assessment was started.

Returns:	the start time
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – `has_started()` is `false`

compliance: mandatory – This method must be implemented.

has_ended()¶

Tests if this assessment has ended.

Returns:	`true` if the assessment has ended, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

completion_time¶

Gets the time of this assessment was completed.

Returns:	the end time
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – `has_ended()` is `false`

compliance: mandatory – This method must be implemented.

time_spent¶

Gets the total time spent taking this assessment.

Returns:	the total time spent
Return type:	`osid.calendaring.Duration`

compliance: mandatory – This method must be implemented.

completion¶

Gets a completion percentage of the assessment.

Returns:	the percent complete (0-100)
Return type:	`cardinal`

compliance: mandatory – This method must be implemented.

is_scored()¶

Tests if a score is available for this assessment.

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

compliance: mandatory – This method must be implemented.

score_system_id¶

Gets a score system Id for the assessment.

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

compliance: mandatory – This method must be implemented.

score_system¶

Gets a grade system for the score.

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

compliance: mandatory – This method must be implemented.

score¶

Gets a score for the assessment.

Returns:	the score
Return type:	`decimal`
Raise:	`IllegalState` – `is_scored()` is `false`

compliance: mandatory – This method must be implemented.

is_graded()¶

Tests if a grade is available for this assessment.

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

compliance: mandatory – This method must be implemented.

grade_id¶

Gets a grade Id for the assessment.

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

compliance: mandatory – This method must be implemented.

grade¶

Gets a grade for the assessment.

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

compliance: mandatory – This method must be implemented.

feedback¶

Gets any overall comments available for this assessment by the grader.

Returns:	comments
Return type:	`osid.locale.DisplayText`

compliance: mandatory – This method must be implemented.

has_rubric()¶

Tests if a rubric assessment is associated with this assessment.

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

compliance: mandatory – This method must be implemented.

rubric_id¶

Gets the Id of the rubric.

Returns:	an assessment taken `Id`
Return type:	`osid.id.Id`
Raise:	`IllegalState` – `has_rubric()` is `false`

compliance: mandatory – This method must be implemented.

rubric¶

Gets the rubric.

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

compliance: mandatory – This method must be implemented.

get_assessment_taken_record(assessment_taken_record_type)¶

Gets the assessment taken record corresponding to the given AssessmentTaken record Type.

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

Parameters:	assessment_taken_record_type (`osid.type.Type`) – an assessment taken record type
Returns:	the assessment taken record
Return type:	`osid.assessment.records.AssessmentTakenRecord`
Raise:	`NullArgument` – `assessment_taken_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(assessment_taken_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Assessment Taken Form¶

class dlkit.assessment.objects.AssessmentTakenForm¶

Bases: dlkit.osid.objects.OsidObjectForm

This is the form for creating and updating an AssessmentTaken.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AssessmentTakenAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

taker_metadata¶

Gets the metadata for a resource to manually set which resource will be taking the assessment.

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

compliance: mandatory – This method must be implemented.

taker¶

get_assessment_taken_form_record(assessment_taken_record_type)¶

Gets the AssessmentTakenFormRecord corresponding to the given assessment taken record Type.

Parameters:	assessment_taken_record_type (`osid.type.Type`) – the assessment taken record type
Returns:	the assessment taken record
Return type:	`osid.assessment.records.AssessmentTakenFormRecord`
Raise:	`NullArgument` – `assessment_taken_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(assessment_taken_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Assessment Taken List¶

class dlkit.assessment.objects.AssessmentTakenList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, AssessmentTakenList provides a means for accessing AssessmentTaken elements sequentially either one at a time or many at a time.

Examples: while (atl.hasNext()) { AssessmentTaken assessment = atl.getNextAssessmentTaken();

or

while (atl.hasNext()) {: AssessmentTaken[] assessments = atl.hetNextAssessmentsTaken(atl.available());

}

next_assessment_taken¶

Gets the next AssessmentTaken in this list.

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

compliance: mandatory – This method must be implemented.

get_next_assessments_taken(n)¶

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

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

compliance: mandatory – This method must be implemented.

Assessment Section¶

class dlkit.assessment.objects.AssessmentSection¶

Bases: dlkit.osid.objects.OsidObject

Represents an assessment section.

An assessment section represents a cluster of questions used to organize the execution of an assessment. The section is the student aspect of an assessment part.

assessment_taken_id¶

Gets the Id of the AssessmentTaken.

Returns:	the assessment taken `Id`
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

assessment_taken¶

Gets the AssessmentTakeb.

Returns:	the assessment taken
Return type:	`osid.assessment.AssessmentTaken`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

has_allocated_time()¶

Tests if this section must be completed within an allocated time.

Returns:	`true` if this section has an allocated time, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

allocated_time¶

Gets the allocated time for this section.

Returns:	allocated time
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – `has_allocated_time()` is `false`

compliance: mandatory – This method must be implemented.

are_items_sequential()¶

Tests if the items or parts in this section are taken sequentially.

Returns:	`true` if the items are taken sequentially, `false` if the items can be skipped and revisited
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

are_items_shuffled()¶

Tests if the items or parts appear in a random order.

Returns:	`true` if the items appear in a random order, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

get_assessment_section_record(assessment_section_record_type)¶

Gets the assessment section record corresponding to the given AssessmentSection record Type.

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

Parameters:	assessment_section_record_type (`osid.type.Type`) – an assessment section record type
Returns:	the assessment section record
Return type:	`osid.assessment.records.AssessmentSectionRecord`
Raise:	`NullArgument` – `assessment_section_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(assessment_section_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Assessment Section List¶

class dlkit.assessment.objects.AssessmentSectionList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, AssessmentSectionList provides a means for accessing AssessmentSection elements sequentially either one at a time or many at a time.

Examples: while (asl.hasNext()) { AssessmentSection section = asl.getNextAssessmentSection();

or

while (asl.hasNext()) {: AssessmentSection[] sections = asl.hetNextAssessmentSections(asl.available());

}

next_assessment_section¶

Gets the next AssessmentSection in this list.

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

compliance: mandatory – This method must be implemented.

get_next_assessment_sections(n)¶

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

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

compliance: mandatory – This method must be implemented.

Bank¶

class dlkit.assessment.objects.Bank(abc_assessment_objects.Bank, osid_objects.OsidCatalog)¶

:noindex:

get_bank_record(bank_record_type)¶

Gets the bank record corresponding to the given Bank record Type.

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

Parameters:	bank_record_type (`osid.type.Type`) – a bank record type
Returns:	the bank record
Return type:	`osid.assessment.records.BankRecord`
Raise:	`NullArgument` – `bank_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(bank_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Bank Form¶

class dlkit.assessment.objects.BankForm¶

Bases: dlkit.osid.objects.OsidCatalogForm

This is the form for creating and updating banks.

Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BankAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

get_bank_form_record(bank_record_type)¶

Gets the BankFormRecord corresponding to the given bank record Type.

Parameters:	bank_record_type (`osid.type.Type`) – a bank record type
Returns:	the bank record
Return type:	`osid.assessment.records.BankFormRecord`
Raise:	`NullArgument` – `bank_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(bank_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Bank List¶

class dlkit.assessment.objects.BankList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, BankList provides a means for accessing Bank elements sequentially either one at a time or many at a time.

Examples: while (bl.hasNext()) { Bank bank = bl.getNextBank(); }

or

while (bl.hasNext()) {: Bank[] banks = bl.getNextBanks(bl.available());

}

next_bank¶

Gets the next Bank in this list.

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

compliance: mandatory – This method must be implemented.

get_next_banks(n)¶

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

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

compliance: mandatory – This method must be implemented.

Bank Node¶

class dlkit.assessment.objects.BankNode¶

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 BankHierarchySession.

bank¶

Gets the Bank at this node.

Returns:	the bank represented by this node
Return type:	`osid.assessment.Bank`

compliance: mandatory – This method must be implemented.

parent_bank_nodes¶

Gets the parents of this bank.

Returns:	the parents of this node
Return type:	`osid.assessment.BankNodeList`

compliance: mandatory – This method must be implemented.

child_bank_nodes¶

Gets the children of this bank.

Returns:	the children of this node
Return type:	`osid.assessment.BankNodeList`

compliance: mandatory – This method must be implemented.

Bank Node List¶

class dlkit.assessment.objects.BankNodeList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, BankNodeList provides a means for accessing BankNode elements sequentially either one at a time or many at a time.

Examples: while (bnl.hasNext()) { BankNode node = bnl.getNextBankNode(); }

or

while (bnl.hasNext()) {: BankNode[] nodes = bnl.getNextBankNodes(bnl.available());

}

next_bank_node¶

Gets the next BankNode in this list.

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

compliance: mandatory – This method must be implemented.

get_next_bank_nodes(n)¶

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

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

compliance: mandatory – This method must be implemented.

Response List¶

class dlkit.assessment.objects.ResponseList¶

Bases: dlkit.osid.objects.OsidList

Like all OsidLists, ResponseList provides a means for accessing Response elements sequentially either one at a time or many at a time.

Examples: while (rl.hasNext()) { Response response = rl.getNextResponse(); }

or

while (rl.hasNext()) {: Response[] responses = rl.getNextResponses(rl.available());

}

next_response¶

Gets the next Response in this list.

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

compliance: mandatory – This method must be implemented.

get_next_responses(n)¶

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

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

compliance: mandatory – This method must be implemented.