OSID - osid.assessment.ItemQuery Service Interface Definition

Interface	osid.assessment.ItemQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidAggregateableQuery`
Description	This is the query for searching items. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR.`
Method	matchLearningObjectiveId
Description	Sets the learning objective `Id` for this query.
Parameters	`osid.id.Id`	`objectiveId`	a learning objective `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`objectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveIdTerms
Description	Clears all learning objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available.
Return	`boolean`		`true` if a learning objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveQuery
Description	Gets the query for a learning objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the learning objective query
Errors	UNIMPLEMENTED		`supportsLearningObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true.`
Method	matchAnyLearningObjective
Description	Matches an item with any objective.
Parameters	`boolean`	`match`	`true` to match items with any learning objective, `false` to match items with no learning objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveTerms
Description	Clears all learning objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchQuestionId
Description	Sets the question `Id` for this query.
Parameters	`osid.id.Id`	`questionId`	a question `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`questionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuestionIdTerms
Description	Clears all question `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsQuestionQuery
Description	Tests if a `QuestionQuery` is available.
Return	`boolean`		`true` if a question query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQuestionQuery
Description	Gets the query for a question. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.QuestionQuery`		the question query
Errors	UNIMPLEMENTED		`supportsQuestionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true.`
Method	matchAnyQuestion
Description	Matches an item with any question.
Parameters	`boolean`	`match`	`true` to match items with any question, `false` to match items with no questions
Compliance	`mandatory`		This method must be implemented.
Method	clearQuestionTerms
Description	Clears all question terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAnswerId
Description	Sets the answer `Id` for this query.
Parameters	`osid.id.Id`	`answerId`	an answer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`answerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAnswerIdTerms
Description	Clears all answer `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAnswerQuery
Description	Tests if an `AnswerQuery` is available.
Return	`boolean`		`true` if an answer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAnswerQuery
Description	Gets the query for an answer. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AnswerQuery`		the answer query
Errors	UNIMPLEMENTED		`supportsAnswerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true.`
Method	matchAnyAnswer
Description	Matches an item with any answer.
Parameters	`boolean`	`match`	`true` to match items with any answer, `false` to match items with no answers
Compliance	`mandatory`		This method must be implemented.
Method	clearAnswerTerms
Description	Clears all answer terms.
Compliance	`mandatory`		This method must be implemented.
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 negative match
Errors	NULL_ARGUMENT		`assessmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentIdTerms
Description	Clears all assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if an `AssessmentQuery` is available.
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 item with any assessment.
Parameters	`boolean`	`match`	`true` to match items with any assessment, `false` to match items with no assessments
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears all assessment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankId
Description	Sets the bank `Id` for this query.
Parameters	`osid.id.Id`	`bankId`	a bank `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`bankId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBankIdTerms
Description	Clears all bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBankQuery
Description	Tests if a `BankQuery` is available.
Return	`boolean`		`true` if a bank query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBankQuery
Description	Gets the query for a bank. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.BankQuery`		the bank query
Errors	UNIMPLEMENTED		`supportsBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBankQuery()` is `true.`
Method	clearBankTerms
Description	Clears all bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	getItemQueryRecord
Description	Gets the item record query corresponding to the given `Item` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.assessment.records.ItemQueryRecord`		the item query record
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(itemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.