OSID - osid.assessment.BankQuery Service Interface Definition

Interface	osid.assessment.BankQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.assessment.AssessmentOfferedQuery`
	`osid.assessment.AssessmentQuery`
	`osid.assessment.AssessmentTakenQuery`
	`osid.assessment.BankQuery`
	`osid.assessment.BankQuerySession`
	`osid.assessment.BankSearchSession`
	`osid.assessment.ItemQuery`
	`osid.assessment.authoring.AssessmentPartQuery`
	`osid.assessment.authoring.SequenceRuleEnablerQuery`
	`osid.assessment.authoring.SequenceRuleQuery`
Description	This is the query for searching banks Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchItemId
Description	Sets the item `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`itemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemIdTerms
Description	Clears all item `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if a `ItemQuery` is available.
Return	`boolean`		`true` if an item query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemQuery
Description	Gets the query for an item. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.ItemQuery`		the item query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true`.
Method	matchAnyItem
Description	Matches assessment banks that have any item assigned.
Parameters	`boolean`	`match`	`true` to match banks with any item, `false` to match assessments with no item
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears all item 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 a 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 assessment banks that have any assessment assigned.
Parameters	`boolean`	`match`	`true` to match banks with any assessment, `false` to match banks with no assessment
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears all assessment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssessmentOfferedId
Description	Sets the assessment offered `Id` for this query.
Parameters	`osid.id.Id`	`assessmentOfferedId`	an assessment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentOfferedIdTerms
Description	Clears all assessment offered `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentOfferedQuery
Description	Tests if an `AssessmentOfferedQuery` is available.
Return	`boolean`		`true` if an assessment offered query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentOfferedQuery
Description	Gets the query for an assessment offered. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentOfferedQuery`		the assessment offered query
Errors	UNIMPLEMENTED		`supportsAssessmentOfferedQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentOfferedQuery()` is `true`.
Method	matchAnyAssessmentOffered
Description	Matches assessment banks that have any assessment offering assigned.
Parameters	`boolean`	`match`	`true` to match banks with any assessment offering, `false` to match banks with no offering
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentOfferedTerms
Description	Clears all assessment offered terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorBankId
Description	Sets the bank `Id` for to match banks in which the specified bank is an acestor.
Parameters	`osid.id.Id`	`bankId`	a bank `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`bankId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBankIdTerms
Description	Clears all ancestor bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorBankQuery
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	getAncestorBankQuery
Description	Gets the query for an ancestor bank. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.BankQuery`		the bank query
Errors	UNIMPLEMENTED		`supportsAncestorBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorBankQuery()` is `true`.
Method	matchAnyAncestorBank
Description	Matches a bank that has any ancestor.
Parameters	`boolean`	`match`	`true` to match banks with any ancestor banks, `false` to match root banks
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBankTerms
Description	Clears all ancestor bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantBankId
Description	Sets the bank `Id` for to match banks in which the specified bank is a descendant.
Parameters	`osid.id.Id`	`bankId`	a bank `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`bankId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBankIdTerms
Description	Clears all descendant bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantBankQuery
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	getDescendantBankQuery
Description	Gets the query for a descendant bank. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.BankQuery`		the bank query
Errors	UNIMPLEMENTED		`supportsDescendantBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBankQuery()` is `true`.
Method	matchAnyDescendantBank
Description	Matches a bank that has any descendant.
Parameters	`boolean`	`match`	`true` to match banks with any descendant banks, `false` to match leaf banks
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBankTerms
Description	Clears all descendant bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBankQueryRecord
Description	Gets the bank query record corresponding to the given `Bank` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`bankRecordType`	a bank record type
Return	`osid.assessment.records.BankQueryRecord`		the bank query record
Errors	NULL_ARGUMENT		`bankRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(bankRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.