OSID - osid.learning.ObjectiveQuery Service Interface Definition

Interface	osid.learning.ObjectiveQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidFederateableQuery`
Description	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.`
Method	matchAssessmentId
Description	Sets the assessment `Id` for this query.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentIdTerms
Description	Clears the assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if an `AssessmentQuery` is available for querying activities.
Return	`boolean`		`true` if an assessment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentQuery
Description	Gets the query for an assessment. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentQuery`		the assessment query
Errors	UNIMPLEMENTED		`supportsAssessmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentQuery()` is `true.`
Method	matchAnyAssessment
Description	Matches an objective that has any assessment assigned.
Parameters	`boolean`	`match`	`true` to match objectives with any assessment, `false` to match objectives with no assessment
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears the assessment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchKnowledgeCategoryId
Description	Sets the knowledge category `Id` for this query.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearKnowledgeCategoryIdTerms
Description	Clears the knowledge category `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsKnowledgeCategoryQuery
Description	Tests if a `GradeQuery` is available for querying knowledge categories.
Return	`boolean`		`true` if a grade query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getKnowledgeCategoryQuery
Description	Gets the query for a knowledge category. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the grade query
Errors	UNIMPLEMENTED		`supportsKnowledgeCategoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKnowledgeCategoryQuery()` is `true.`
Method	matchAnyKnowledgeCategory
Description	Matches an objective that has any knowledge category.
Parameters	`boolean`	`match`	`true` to match objectives with any knowledge category, `false` to match objectives with no knowledge category
Compliance	`mandatory`		This method must be implemented.
Method	clearKnowledgeCategoryTerms
Description	Clears the knowledge category terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCognitiveProcessId
Description	Sets the cognitive process `Id` for this query.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCognitiveProcessIdTerms
Description	Clears the cognitive process `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCognitiveProcessQuery
Description	Tests if a `GradeQuery` is available for querying cognitive processes.
Return	`boolean`		`true` if a grade query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCognitiveProcessQuery
Description	Gets the query for a cognitive process. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the grade query
Errors	UNIMPLEMENTED		`supportsCognitiveProcessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCognitiveProcessQuery()` is `true.`
Method	matchAnyCognitiveProcess
Description	Matches an objective that has any cognitive process.
Parameters	`boolean`	`match`	`true` to match objectives with any cognitive process, `false` to match objectives with no cognitive process
Compliance	`mandatory`		This method must be implemented.
Method	clearCognitiveProcessTerms
Description	Clears the cognitive process terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityId
Description	Sets the activity `Id` for this query.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityIdTerms
Description	Clears the activity `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if an `ActivityQuery` is available for querying activities.
Return	`boolean`		`true` if an activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQuery
Description	Gets the query for an activity. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityQuery()` is `true.`
Method	matchAnyActivity
Description	Matches an objective that has any related activity.
Parameters	`boolean`	`match`	`true` to match objectives with any activity, `false` to match objectives with no activity
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequisiteObjectiveId
Description	Sets the requisite objective `Id` for this query.
Parameters	`osid.id.Id`	`requisiteObjectiveId`	a requisite objective `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`requisiteObjectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequisiteObjectiveIdTerms
Description	Clears the requisite objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available for querying requisite objectives.
Return	`boolean`		`true` if an objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteObjectiveQuery
Description	Gets the query for a requisite objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsRequisiteObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteObjectiveQuery()` is `true.`
Method	matchAnyRequisiteObjective
Description	Matches an objective that has any related requisite.
Parameters	`boolean`	`match`	`true` to match objectives with any requisite, `false` to match objectives with no requisite
Compliance	`mandatory`		This method must be implemented.
Method	clearRequisiteObjectiveTerms
Description	Clears the requisite objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDependentObjectiveId
Description	Sets the dependent objective `Id` to query objectives dependent on the given objective.
Parameters	`osid.id.Id`	`dependentObjectiveId`	a dependent objective `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`dependentObjectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDependentObjectiveIdTerms
Description	Clears the dependent objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDepndentObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available for querying dependent objectives.
Return	`boolean`		`true` if an objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDependentObjectiveQuery
Description	Gets the query for a dependent objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsDependentObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDependentQuery()` is `true.`
Method	matchAnyDependentObjective
Description	Matches an objective that has any related dependents.
Parameters	`boolean`	`match`	`true` to match objectives with any dependent, `false` to match objectives with no dependents
Compliance	`mandatory`		This method must be implemented.
Method	clearDependentObjectiveTerms
Description	Clears the dependent objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEquivalentObjectiveId
Description	Sets the equivalent objective `Id` to query equivalents.
Parameters	`osid.id.Id`	`equivalentObjectiveId`	an equivalent objective `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`equivalentObjectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEquivalentObjectiveIdTerms
Description	Clears the equivalent objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEquivalentObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available for querying equivalent objectives.
Return	`boolean`		`true` if an objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEquivalentObjectiveQuery
Description	Gets the query for an equivalent objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsEquivalentObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEquivalentQuery()` is `true.`
Method	matchAnyEquivalentObjective
Description	Matches an objective that has any related equivalents.
Parameters	`boolean`	`match`	`true` to match objectives with any equivalent, `false` to match objectives with no equivalents
Compliance	`mandatory`		This method must be implemented.
Method	clearEquivalentObjectiveTerms
Description	Clears the equivalent objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorObjectiveId
Description	Sets the objective `Id` for this query to match objectives that have the specified objective as an ancestor.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`objectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorObjectiveIdTerms
Description	Clears the ancestor objective `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available.
Return	`boolean`		`true` if an objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorObjectiveQuery
Description	Gets the query for an objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsAncestorObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorObjectiveQuery()` is `true.`
Method	matchAnyAncestorObjective
Description	Matches objectives that have any ancestor.
Parameters	`boolean`	`match`	`true` to match objective with any ancestor, `false` to match root objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorObjectiveTerms
Description	Clears the ancestor objective query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantObjectiveId
Description	Sets the objective `Id` for this query to match objectives that have the specified objective as a descendant.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`objectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantObjectiveIdTerms
Description	Clears the descendant objective `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available.
Return	`boolean`		`true` if an objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantObjectiveQuery
Description	Gets the query for an objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsDescendantObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantObjectiveQuery()` is `true.`
Method	matchAnyDescendantObjective
Description	Matches objectives that have any ancestor.
Parameters	`boolean`	`match`	`true` to match objectives with any ancestor, `false` to match leaf objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantObjectiveTerms
Description	Clears the descendant objective query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchObjectiveBankId
Description	Sets the objective bank `Id` for this query.
Parameters	`osid.id.Id`	`objectiveBankId`	an objective bank `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`objectiveBankId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearObjectiveBankIdTerms
Description	Clears the objective bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankQuery
Description	Tests if a `ObjectiveBankQuery` is available for querying objective banks.
Return	`boolean`		`true` if an objective bank query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBankQuery
Description	Gets the query for an objective bank. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveBankQuery`		the objective bank query
Errors	UNIMPLEMENTED		`supportsObjectiveBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsObjectiveBankQuery()` is `true.`
Method	clearObjectiveBankTerms
Description	Clears the objective bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveQueryRecord
Description	Gets the objective query record corresponding to the given `Objective` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`objectiveRecordType`	an objective query record type
Return	`osid.learning.records.ObjectiveQueryRecord`		the objective query record
Errors	NULL_ARGUMENT		`objectiveRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(objectiveRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.