Objects¶

Assessment Part¶

class dlkit.assessment_authoring.objects.AssessmentPart¶

Bases: dlkit.osid.objects.OsidObject, dlkit.osid.markers.Containable, dlkit.osid.markers.Operable

An AssessmentPart represents a section of an assessment.

AssessmentParts may be visible as sections of an assessment or just used to clump together a set of items on which to hang sequence rules.

assessment_id¶

Gets the assessment Id to which this rule belongs.

Returns:	`Id` of an assessment
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

assessment¶

Gets the assessment to which this rule belongs.

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

compliance: mandatory – This method must be implemented.

has_parent_part()¶

Tests if this assessment part belongs to a parent assessment part.

Returns:	`true` if this part has a parent, `false` if a root
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

assessment_part_id¶

Gets the parent assessment Id.

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

compliance: mandatory – This method must be implemented.

assessment_part¶

Gets the parent assessment.

Returns:	the parent assessment part
Return type:	`osid.assessment.authoring.AssessmentPart`
Raise:	`IllegalState` – `has_parent_part()` is `false`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

is_section()¶

Tests if this part should be visible as a section in an assessment.

If visible, this part will appear to the user as a separate section of the assessment. Typically, a section may not be under a non-sectioned part.

Returns:	`true` if this part is a section, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

weight¶

Gets an integral weight factor for this assessment part used for scoring.

The percentage weight for this part is this weight divided by the sum total of all the weights in the assessment.

Returns:	the weight
Return type:	`cardinal`

compliance: mandatory – This method must be implemented.

allocated_time¶

Gets the allocated time for this part.

The allocated time may be used to assign fixed time limits to each item or can be used to estimate the total assessment time.

Returns:	allocated time
Return type:	`osid.calendaring.Duration`

compliance: mandatory – This method must be implemented.

child_assessment_part_ids¶

Gets any child assessment part Ids.

Returns:	`Ids` of the child assessment parts
Return type:	`osid.id.IdList`

compliance: mandatory – This method must be implemented.

child_assessment_parts¶

Gets any child assessment parts.

Returns:	the child assessment parts
Return type:	`osid.assessment.authoring.AssessmentPartList`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

get_assessment_part_record(assessment_part_record_type)¶

Gets the assessment part record corresponding to the given AssessmentPart record Type.

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

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

compliance: mandatory – This method must be implemented.

Assessment Part Form¶

class dlkit.assessment_authoring.objects.AssessmentPartForm¶

Bases: dlkit.osid.objects.OsidObjectForm, dlkit.osid.objects.OsidContainableForm, dlkit.osid.objects.OsidOperableForm

This is the form for creating and updating AssessmentParts.

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

weight_metadata¶

Gets the metadata for the weight.

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

compliance: mandatory – This method must be implemented.

weight¶

allocated_time_metadata¶

Gets the metadata for the allocated time.

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

compliance: mandatory – This method must be implemented.

allocated_time¶

get_assessment_part_form_record(assessment_part_record_type)¶

Gets the AssessmentPartFormRecord corresponding to the given assessment record Type.

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

compliance: mandatory – This method must be implemented.

Assessment Part List¶

class dlkit.assessment_authoring.objects.AssessmentPartList¶

Bases: dlkit.osid.objects.OsidList

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

Examples: while (apl.hasNext()) { AssessmentPart assessmentPart = apl.getNextAssessmentPart(); }

or

while (apl.hasNext()) {: AssessmentPart[] assessmentParts = apl.hetNextAssessmentParts(apl.available());

}

next_assessment_part¶

Gets the next AssessmentPart in this list.

Returns:	the next `AssessmentPart` in this list. The `has_next()` method should be used to test that a next `AssessmentPart` is available before calling this method.
Return type:	`osid.assessment.authoring.AssessmentPart`
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_parts(n)¶

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

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

compliance: mandatory – This method must be implemented.

Sequence Rule¶

class dlkit.assessment_authoring.objects.SequenceRule¶

Bases: dlkit.osid.objects.OsidRule

A SequenceRule defines the ordering of AssessmentParts.

assessment_part_id¶

Gets the assessment part Id to which this rule belongs.

Returns:	`Id` of an assessment part
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

assessment_part¶

Gets the assessment part to which this rule belongs.

Returns:	an assessment part
Return type:	`osid.assessment.authoring.AssessmentPart`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

next_assessment_part_id¶

Gets the next assessment part Id for success of this rule.

Returns:	`Id` of an assessment part
Return type:	`osid.id.Id`

compliance: mandatory – This method must be implemented.

next_assessment_part¶

Gets the next assessment part for success of this rule.

Returns:	an assessment part
Return type:	`osid.assessment.authoring.AssessmentPart`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

minimum_score¶

Gets the minimum score expressed as an integer (0-100) for this rule.

Returns:	minimum score
Return type:	`cardinal`

compliance: mandatory – This method must be implemented.

maximum_score¶

Gets the maximum score expressed as an integer (0-100) for this rule.

Returns:	maximum score
Return type:	`cardinal`

compliance: mandatory – This method must be implemented.

is_cumulative()¶

Tests if the score is applied to all previous assessment parts.

Returns:	`true` if the score is applied to all previous assessment parts, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

applied_assessment_part_ids¶

Qualifies is_cumulative() to apply to a specific list of assessment parts.

If is_cumulative() is true, this method may return an empty list to mean all previous assessment parts.

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

compliance: mandatory – This method must be implemented.

applied_assessment_parts¶

Qualifies is_cumulative() to apply to a specific list of assessment parts.

If is_cumulative() is true, this method may return an empty list to mean all previous assessment parts.

Returns:	list of assessment parts
Return type:	`osid.assessment.authoring.AssessmentPartList`
Raise:	`IllegalState` – `is_cumulative()` is `false`
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

get_sequence_rule_record(sequence_rule_record_type)¶

Gets the assessment sequence rule record corresponding to the given SequenceRule record Type.

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

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

compliance: mandatory – This method must be implemented.

Sequence Rule Form¶

class dlkit.assessment_authoring.objects.SequenceRuleForm¶

Bases: dlkit.osid.objects.OsidRuleForm

This is the form for creating and updating sequence rules.

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

minimum_score_metadata¶

Gets the metadata for the minimum score.

Returns:	metadata for the minimum score
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

minimum_score¶

maximum_score_metadata¶

Gets the metadata for the maximum score.

Returns:	metadata for the maximum score
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

maximum_score¶

cumulative_metadata¶

Gets the metadata for the cumulative flag.

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

compliance: mandatory – This method must be implemented.

cumulative¶

applied_assessment_parts_metadata¶

Gets the metadata for the applied assessment parts.

Returns:	metadata for the applied assessment parts
Return type:	`osid.Metadata`

compliance: mandatory – This method must be implemented.

apply_assessment_parts(assessment_part_ids)¶

Designates assessment parts to which the rule applies.

Parameters:	assessment_part_ids (`osid.id.Id[]`) – the parts to which this rule should apply
Raise:	`InvalidArgument` – `assessment_part_ids` is invalid
Raise:	`NoAccess` – `Metadata.isReadOnly()` is `true`
Raise:	`NullArgument` – `assessment_part_ids` is `null`

compliance: mandatory – This method must be implemented.

get_sequence_rule_form_record(sequence_rule_record)¶

Gets the SequenceRuleFormRecord corresponding to the given sequence rule record Type.

Parameters:	sequence_rule_record (`osid.type.Type`) – a sequence rule record type
Returns:	the sequence rule record
Return type:	`osid.assessment.authoring.records.SequenceRuleFormRecord`
Raise:	`NullArgument` – `sequence_rule_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(asequence_rule_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Sequence Rule List¶

class dlkit.assessment_authoring.objects.SequenceRuleList¶

Bases: dlkit.osid.objects.OsidList

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

Examples: while (srl.hasNext()) { AssessmentSequenceRule rule = srl.getNextAssessmentSequenceRule(); }

or

while (srl.hasNext()) {: AssessmentSequenceRule[] rules = srl.getNextAssessmentSequenceRules(srl.available());

}

next_sequence_rule¶

Gets the next SequenceRule in this list.

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

compliance: mandatory – This method must be implemented.

get_next_sequence_rules(n)¶

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

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

compliance: mandatory – This method must be implemented.