Queries¶

Objective Query¶

class dlkit.learning.queries.ObjectiveQuery¶

Bases: dlkit.osid.queries.OsidObjectQuery, dlkit.osid.queries.OsidFederateableQuery

This is the query for searching objectives.

Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

match_assessment_id(assessment_id, match)¶

Sets the assessment Id for this query.

Parameters:	assessment_id (`osid.id.Id`) – an assessment `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `assessment_id` is `null`

compliance: mandatory – This method must be implemented.

assessment_id_terms¶

supports_assessment_query()¶

Tests if an AssessmentQuery is available for querying activities.

Returns:	`true` if an assessment query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

assessment_query¶

Gets the query for an assessment.

Multiple retrievals produce a nested OR term.

Returns:	the assessment query
Return type:	`osid.assessment.AssessmentQuery`
Raise:	`Unimplemented` – `supports_assessment_query()` is `false`

compliance: optional – This method must be implemented if ``supports_assessment_query()`` is ``true``.

match_any_assessment(match)¶

Matches an objective that has any assessment assigned.

Parameters:	match (`boolean`) – `true` to match objectives with any assessment, `false` to match objectives with no assessment

compliance: mandatory – This method must be implemented.

assessment_terms¶

match_knowledge_category_id(grade_id, match)¶

Sets the knowledge category Id for this query.

Parameters:	grade_id (`osid.id.Id`) – a grade `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `grade_id` is `null`

compliance: mandatory – This method must be implemented.

knowledge_category_id_terms¶

supports_knowledge_category_query()¶

Tests if a GradeQuery is available for querying knowledge categories.

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

compliance: mandatory – This method must be implemented.

knowledge_category_query¶

Gets the query for a knowledge category.

Multiple retrievals produce a nested OR term.

Returns:	the grade query
Return type:	`osid.grading.GradeQuery`
Raise:	`Unimplemented` – `supports_knowledge_category_query()` is `false`

compliance: optional – This method must be implemented if ``supports_knowledge_category_query()`` is ``true``.

match_any_knowledge_category(match)¶

Matches an objective that has any knowledge category.

Parameters:	match (`boolean`) – `true` to match objectives with any knowledge category, `false` to match objectives with no knowledge category

compliance: mandatory – This method must be implemented.

knowledge_category_terms¶

match_cognitive_process_id(grade_id, match)¶

Sets the cognitive process Id for this query.

Parameters:	grade_id (`osid.id.Id`) – a grade `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `grade_id` is `null`

compliance: mandatory – This method must be implemented.

cognitive_process_id_terms¶

supports_cognitive_process_query()¶

Tests if a GradeQuery is available for querying cognitive processes.

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

compliance: mandatory – This method must be implemented.

cognitive_process_query¶

Gets the query for a cognitive process.

Multiple retrievals produce a nested OR term.

Returns:	the grade query
Return type:	`osid.grading.GradeQuery`
Raise:	`Unimplemented` – `supports_cognitive_process_query()` is `false`

compliance: optional – This method must be implemented if ``supports_cognitive_process_query()`` is ``true``.

match_any_cognitive_process(match)¶

Matches an objective that has any cognitive process.

Parameters:	match (`boolean`) – `true` to match objectives with any cognitive process, `false` to match objectives with no cognitive process

compliance: mandatory – This method must be implemented.

cognitive_process_terms¶

match_activity_id(activity_id, match)¶

Sets the activity Id for this query.

Parameters:	activity_id (`osid.id.Id`) – an activity `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `activity_id` is `null`

compliance: mandatory – This method must be implemented.

activity_id_terms¶

supports_activity_query()¶

Tests if an ActivityQuery is available for querying activities.

Returns:	`true` if an activity query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

activity_query¶

Gets the query for an activity.

Multiple retrievals produce a nested OR term.

Returns:	the activity query
Return type:	`osid.learning.ActivityQuery`
Raise:	`Unimplemented` – `supports_activity_query()` is `false`

compliance: optional – This method must be implemented if ``supports_activity_query()`` is ``true``.

match_any_activity(match)¶

Matches an objective that has any related activity.

Parameters:	match (`boolean`) – `true` to match objectives with any activity, `false` to match objectives with no activity

compliance: mandatory – This method must be implemented.

activity_terms¶

match_requisite_objective_id(requisite_objective_id, match)¶

Sets the requisite objective Id for this query.

Parameters:	requisite_objective_id (`osid.id.Id`) – a requisite objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `requisite_objective_id` is `null`

compliance: mandatory – This method must be implemented.

requisite_objective_id_terms¶

supports_requisite_objective_query()¶

Tests if an ObjectiveQuery is available for querying requisite objectives.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

requisite_objective_query¶

Gets the query for a requisite objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_requisite_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_requisite_objective_query()`` is ``true``.

match_any_requisite_objective(match)¶

Matches an objective that has any related requisite.

Parameters:	match (`boolean`) – `true` to match objectives with any requisite, `false` to match objectives with no requisite

compliance: mandatory – This method must be implemented.

requisite_objective_terms¶

match_dependent_objective_id(dependent_objective_id, match)¶

Sets the dependent objective Id to query objectives dependent on the given objective.

Parameters:	dependent_objective_id (`osid.id.Id`) – a dependent objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `dependent_objective_id` is `null`

compliance: mandatory – This method must be implemented.

dependent_objective_id_terms¶

supports_depndent_objective_query()¶

Tests if an ObjectiveQuery is available for querying dependent objectives.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

dependent_objective_query¶

Gets the query for a dependent objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_dependent_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_dependent_query()`` is ``true``.

match_any_dependent_objective(match)¶

Matches an objective that has any related dependents.

Parameters:	match (`boolean`) – `true` to match objectives with any dependent, `false` to match objectives with no dependents

compliance: mandatory – This method must be implemented.

dependent_objective_terms¶

match_equivalent_objective_id(equivalent_objective_id, match)¶

Sets the equivalent objective Id to query equivalents.

Parameters:	equivalent_objective_id (`osid.id.Id`) – an equivalent objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `equivalent_objective_id` is `null`

compliance: mandatory – This method must be implemented.

equivalent_objective_id_terms¶

supports_equivalent_objective_query()¶

Tests if an ObjectiveQuery is available for querying equivalent objectives.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

equivalent_objective_query¶

Gets the query for an equivalent objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_equivalent_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_equivalent_query()`` is ``true``.

match_any_equivalent_objective(match)¶

Matches an objective that has any related equivalents.

Parameters:	match (`boolean`) – `true` to match objectives with any equivalent, `false` to match objectives with no equivalents

compliance: mandatory – This method must be implemented.

equivalent_objective_terms¶

match_ancestor_objective_id(objective_id, match)¶

Sets the objective Id for this query to match objectives that have the specified objective as an ancestor.

Parameters:	objective_id (`osid.id.Id`) – an objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_id` is `null`

compliance: mandatory – This method must be implemented.

ancestor_objective_id_terms¶

supports_ancestor_objective_query()¶

Tests if an ObjectiveQuery is available.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

ancestor_objective_query¶

Gets the query for an objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_ancestor_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_ancestor_objective_query()`` is ``true``.

match_any_ancestor_objective(match)¶

Matches objectives that have any ancestor.

Parameters:	match (`boolean`) – `true` to match objective with any ancestor, `false` to match root objectives

compliance: mandatory – This method must be implemented.

ancestor_objective_terms¶

match_descendant_objective_id(objective_id, match)¶

Sets the objective Id for this query to match objectives that have the specified objective as a descendant.

Parameters:	objective_id (`osid.id.Id`) – an objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_id` is `null`

compliance: mandatory – This method must be implemented.

descendant_objective_id_terms¶

supports_descendant_objective_query()¶

Tests if an ObjectiveQuery is available.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

descendant_objective_query¶

Gets the query for an objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_descendant_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_descendant_objective_query()`` is ``true``.

match_any_descendant_objective(match)¶

Matches objectives that have any ancestor.

Parameters:	match (`boolean`) – `true` to match objectives with any ancestor, `false` to match leaf objectives

compliance: mandatory – This method must be implemented.

descendant_objective_terms¶

match_objective_bank_id(objective_bank_id, match)¶

Sets the objective bank Id for this query.

Parameters:	objective_bank_id (`osid.id.Id`) – an objective bank `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_bank_id` is `null`

compliance: mandatory – This method must be implemented.

objective_bank_id_terms¶

supports_objective_bank_query()¶

Tests if a ObjectiveBankQuery is available for querying objective banks.

Returns:	`true` if an objective bank query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

objective_bank_query¶

Gets the query for an objective bank.

Multiple retrievals produce a nested OR term.

Returns:	the objective bank query
Return type:	`osid.learning.ObjectiveBankQuery`
Raise:	`Unimplemented` – `supports_objective_bank_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_bank_query()`` is ``true``.

objective_bank_terms¶

get_objective_query_record(objective_record_type)¶

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

Multiple retrievals produce a nested OR term.

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

compliance: mandatory – This method must be implemented.

Activity Query¶

class dlkit.learning.queries.ActivityQuery¶

Bases: dlkit.osid.queries.OsidObjectQuery, dlkit.osid.queries.OsidSubjugateableQuery

This is the query for searching activities.

Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

match_objective_id(objective_id, match)¶

Sets the objective Id for this query.

Parameters:	objective_id (`osid.id.Id`) – an objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_id` is `null`

compliance: mandatory – This method must be implemented.

objective_id_terms¶

supports_objective_query()¶

Tests if an ObjectiveQuery is available for querying objectives.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

objective_query¶

Gets the query for an objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_query()`` is ``true``.

objective_terms¶

match_asset_id(asset_id, match)¶

Sets the asset Id for this query.

Parameters:	asset_id (`osid.id.Id`) – an asset `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `asset_id` is `null`

compliance: mandatory – This method must be implemented.

asset_id_terms¶

supports_asset_query()¶

Tests if an AssetQuery is available for querying objectives.

Returns:	`true` if an robjective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

asset_query¶

Gets the query for an asset.

Multiple retrievals produce a nested OR term.

Returns:	the asset query
Return type:	`osid.repository.AssetQuery`
Raise:	`Unimplemented` – `supports_asset_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_query()`` is ``true``.

match_any_asset(match)¶

Matches an activity that has any objective assigned.

Parameters:	match (`boolean`) – `true` to match activities with any asset, `false` to match activities with no asset

compliance: mandatory – This method must be implemented.

asset_terms¶

match_course_id(course_id, match)¶

Sets the course Id for this query.

Parameters:	course_id (`osid.id.Id`) – a course `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `course_id` is `null`

compliance: mandatory – This method must be implemented.

course_id_terms¶

supports_course_query()¶

Tests if a CourseQuery is available for querying courses.

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

compliance: mandatory – This method must be implemented.

course_query¶

Gets the query for a course.

Multiple retrievals produce a nested OR term.

Returns:	the course query
Return type:	`osid.course.CourseQuery`
Raise:	`Unimplemented` – `supports_course_query()` is `false`

compliance: optional – This method must be implemented if ``supports_course_query()`` is ``true``.

match_any_course(match)¶

Matches an activity that has any course assigned.

Parameters:	match (`boolean`) – `true` to match activities with any courses, `false` to match activities with no courses

compliance: mandatory – This method must be implemented.

course_terms¶

match_assessment_id(assessment_id, match)¶

Sets the assessment Id for this query.

Parameters:	assessment_id (`osid.id.Id`) – an assessment `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `assessment_id` is `null`

compliance: mandatory – This method must be implemented.

assessment_id_terms¶

supports_assessment_query()¶

Tests if an AssessmentQuery is available for querying assessments.

Returns:	`true` if an assessment query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

assessment_query¶

Gets the query for a assessment.

Multiple retrievals produce a nested OR term.

Returns:	the assessment query
Return type:	`osid.assessment.AssessmentQuery`
Raise:	`Unimplemented` – `supports_assessment_query()` is `false`

compliance: optional – This method must be implemented if ``supports_assessment_query()`` is ``true``.

match_any_assessment(match)¶

Matches an activity that has any assessment assigned.

Parameters:	match (`boolean`) – `true` to match activities with any assessments, `false` to match activities with no assessments

compliance: mandatory – This method must be implemented.

assessment_terms¶

match_objective_bank_id(objective_bank_id, match)¶

Sets the objective bank Id for this query.

Parameters:	objective_bank_id (`osid.id.Id`) – an objective bank `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_bank_id` is `null`

compliance: mandatory – This method must be implemented.

objective_bank_id_terms¶

supports_objective_bank_query()¶

Tests if a ObjectiveBankQuery is available for querying resources.

Returns:	`true` if an objective bank query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

objective_bank_query¶

Gets the query for an objective bank.

Multiple retrievals produce a nested OR term.

Returns:	the objective bank query
Return type:	`osid.learning.ObjectiveBankQuery`
Raise:	`Unimplemented` – `supports_objective_bank_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_bank_query()`` is ``true``.

objective_bank_terms¶

get_activity_query_record(activity_record_type)¶

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

Multiple retrievals produce a nested OR term.

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

compliance: mandatory – This method must be implemented.

Proficiency Query¶

class dlkit.learning.queries.ProficiencyQuery¶

Bases: dlkit.osid.queries.OsidRelationshipQuery

This is the query for searching proficiencies.

Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

match_resource_id(resource_id, match)¶

Sets the resource Id for this query.

Parameters:	resource_id (`osid.id.Id`) – a resource `Id` match (`boolean`) – `true` if a positive match, `false` for a negative match
Raise:	`NullArgument` – `resource_id` is `null`

compliance: mandatory – This method must be implemented.

resource_id_terms¶

supports_resource_query()¶

Tests if a ResourceQuery is available.

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

compliance: mandatory – This method must be implemented.

resource_query¶

Gets the query for a resource.

Multiple retrievals produce a nested OR term.

Returns:	the resource query
Return type:	`osid.resource.ResourceQuery`
Raise:	`Unimplemented` – `supports_resource_query()` is `false`

compliance: optional – This method must be implemented if ``supports_resource_query()`` is ``true``.

resource_terms¶

match_objective_id(objective_id, match)¶

Sets the objective Id for this query.

Parameters:	objective_id (`osid.id.Id`) – an objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_id` is `null`

compliance: mandatory – This method must be implemented.

objective_id_terms¶

supports_objective_query()¶

Tests if an ObjectiveQuery is available for querying objectives.

Returns:	`true` if an robjective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

objective_query¶

Gets the query for an objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_query()`` is ``true``.

match_any_objective(match)¶

Matches an activity that has any objective assigned.

Parameters:	match (`boolean`) – `true` to match activities with any objective, `false` to match activities with no objective

compliance: mandatory – This method must be implemented.

objective_terms¶

match_completion(start, end, match)¶

Sets the completion for this query to match completion percentages between the given range inclusive.

Parameters:	start (`decimal`) – start of range end (`decimal`) – end of range match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `end` is less than `start`

compliance: mandatory – This method must be implemented.

completion_terms¶

match_minimum_completion(completion, match)¶

Sets the minimum completion for this query.

Parameters:	completion (`decimal`) – completion percentage match (`boolean`) – `true` for a positive match, `false` for a negative match

compliance: mandatory – This method must be implemented.

minimum_completion_terms¶

match_level_id(grade_id, match)¶

Sets the level grade Id for this query.

Parameters:	grade_id (`osid.id.Id`) – a grade `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `grade_id` is `null`

compliance: mandatory – This method must be implemented.

level_id_terms¶

supports_level_query()¶

Tests if a GradeQuery is available.

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

compliance: mandatory – This method must be implemented.

level_query¶

Gets the query for a grade.

Multiple retrievals produce a nested OR term.

Returns:	the grade query
Return type:	`osid.grading.GradeQuery`
Raise:	`Unimplemented` – `supports_level_query()` is `false`

compliance: optional – This method must be implemented if ``supports_level_query()`` is ``true``.

match_any_level(match)¶

Matches an assessment offered that has any level assigned.

Parameters:	match (`boolean`) – `true` to match offerings with any level, `false` to match offerings with no levsls

compliance: mandatory – This method must be implemented.

level_terms¶

match_objective_bank_id(objective_bank_id, match)¶

Sets the objective bank Id for this query.

Parameters:	objective_bank_id (`osid.id.Id`) – an objective bank `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_bank_id` is `null`

compliance: mandatory – This method must be implemented.

objective_bank_id_terms¶

supports_objective_bank_query()¶

Tests if a ObjectiveBankQuery is available for querying resources.

Returns:	`true` if an objective bank query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

objective_bank_query¶

Gets the query for an objective bank.

Multiple retrievals produce a nested OR term.

Returns:	the objective bank query
Return type:	`osid.learning.ObjectiveBankQuery`
Raise:	`Unimplemented` – `supports_objective_bank_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_bank_query()`` is ``true``.

objective_bank_terms¶

get_proficiency_query_record(proficiency_record_type)¶

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

Multiple retrievals produce a nested OR term.

Parameters:	proficiency_record_type (`osid.type.Type`) – a proficiency offered record type
Returns:	the proficiency offered query record
Return type:	`osid.learning.records.ProficiencyQueryRecord`
Raise:	`NullArgument` – `proficiency_offered_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(proficiency_offered_record_type)` is `false`

compliance: mandatory – This method must be implemented.

Objective Bank Query¶

class dlkit.learning.queries.ObjectiveBankQuery¶

Bases: dlkit.osid.queries.OsidCatalogQuery

This is the query for searching objective banks.

Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

match_objective_id(objective_id, match)¶

Sets the objective Id for this query.

Parameters:	objective_id (`osid.id.Id`) – an objective `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_id` is `null`

compliance: mandatory – This method must be implemented.

objective_id_terms¶

supports_objective_query()¶

Tests if an ObjectiveQuery is available.

Returns:	`true` if an objective query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

objective_query¶

Gets the query for an objective.

Multiple retrievals produce a nested OR term.

Returns:	the objective query
Return type:	`osid.learning.ObjectiveQuery`
Raise:	`Unimplemented` – `supports_objective_query()` is `false`

compliance: optional – This method must be implemented if ``supports_objective_query()`` is ``true``.

match_any_objective(match)¶

Matches an objective bank that has any objective assigned.

Parameters:	match (`boolean`) – `true` to match objective banks with any objective, `false` to match objective banks with no objectives

compliance: mandatory – This method must be implemented.

objective_terms¶

match_activity_id(activity_id, match)¶

Sets the activity Id for this query.

Parameters:	activity_id (`osid.id.Id`) – an activity `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `activity_id` is `null`

compliance: mandatory – This method must be implemented.

activity_id_terms¶

supports_activity_query()¶

Tests if a ActivityQuery is available for querying activities.

Returns:	`true` if an activity query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

activity_query¶

Gets the query for an activity.

Multiple retrievals produce a nested OR term.

Returns:	the activity query
Return type:	`osid.learning.ActivityQuery`
Raise:	`Unimplemented` – `supports_activity_query()` is `false`

compliance: optional – This method must be implemented if ``supports_activity_query()`` is ``true``.

match_any_activity(match)¶

Matches an objective bank that has any activity assigned.

Parameters:	match (`boolean`) – `true` to match objective banks with any activity, `false` to match objective banks with no activities

compliance: mandatory – This method must be implemented.

activity_terms¶

match_ancestor_objective_bank_id(objective_bank_id, match)¶

Sets the objective bank Id for this query to match objective banks that have the specified objective bank as an ancestor.

Parameters:	objective_bank_id (`osid.id.Id`) – an objective bank `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_bank_id` is `null`

compliance: mandatory – This method must be implemented.

ancestor_objective_bank_id_terms¶

supports_ancestor_objective_bank_query()¶

Tests if a ObjectiveBankQuery is available for querying ancestor objective banks.

Returns:	`true` if an objective bank query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

ancestor_objective_bank_query¶

Gets the query for an objective bank.

Multiple retrievals produce a nested OR term.

Returns:	the objective bank query
Return type:	`osid.learning.ObjectiveBankQuery`
Raise:	`Unimplemented` – `supports_ancestor_objective_bank_query()` is `false`

compliance: optional – This method must be implemented if ``supports_ancestor_calndar_query()`` is ``true``.

match_any_ancestor_objective_bank(match)¶

Matches an objective bank that has any ancestor.

Parameters:	match (`boolean`) – `true` to match objective banks with any ancestor, `false` to match root objective banks

compliance: mandatory – This method must be implemented.

ancestor_objective_bank_terms¶

match_descendant_objective_bank_id(objective_bank_id, match)¶

Sets the objective bank Id for this query to match objective banks that have the specified objective bank as a descendant.

Parameters:	objective_bank_id (`osid.id.Id`) – an objective bank `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `objective_bank_id` is `null`

compliance: mandatory – This method must be implemented.

descendant_objective_bank_id_terms¶

supports_descendant_objective_bank_query()¶

Tests if a ObjectiveBankQuery is available for querying descendant objective banks.

Returns:	`true` if an objective bank query is available, `false` otherwise
Return type:	`boolean`

compliance: mandatory – This method must be implemented.

descendant_objective_bank_query¶

Gets the query for an objective bank.

Multiple retrievals produce a nested OR term.

Returns:	the objective bank query
Return type:	`osid.learning.ObjectiveBankQuery`
Raise:	`Unimplemented` – `supports_descendant_objective_bank_query()` is `false`

compliance: optional – This method must be implemented if ``supports_descendant_calndar_query()`` is ``true``.

match_any_descendant_objective_bank(match)¶

Matches an objective bank that has any descendant.

Parameters:	match (`boolean`) – `true` to match objective banks with any descendant, `false` to match leaf objective banks

compliance: mandatory – This method must be implemented.

descendant_objective_bank_terms¶

get_objective_bank_query_record(objective_bank_record_type)¶

Gets the objective bank query record corresponding to the given ObjectiveBank record Type.

Multiple record retrievals produce a nested OR term.

Parameters:	objective_bank_record_type (`osid.type.Type`) – an objective bank record type
Returns:	the objective bank query record
Return type:	`osid.learning.records.ObjectiveBankQueryRecord`
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`

compliance: mandatory – This method must be implemented.