OSID - osid.assessment.authoring.AssessmentPartQuery Service Interface Definition

Interface	osid.assessment.authoring.AssessmentPartQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidContainableQuery`
	`osid.OsidOperableQuery`
Used By	`osid.assessment.authoring.AssessmentPartQuery`
	`osid.assessment.authoring.AssessmentPartQuerySession`
	`osid.assessment.authoring.AssessmentPartSearchSession`
	`osid.assessment.authoring.AssessmentPartSmartBankSession`
	`osid.assessment.authoring.SequenceRuleQuery`
Description	This is the query for searching assessment parts. 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 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	clearAssessmentTerms
Description	Clears all assessment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchParentAssessmentPartId
Description	Sets the assessment part `Id` for this query.
Parameters	`osid.id.Id`	`assessmentPartId`	an assessment part `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentPartId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentAssessmentPartIdTerms
Description	Clears all assessment part `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParentAssessmentPartQuery
Description	Tests if an `AssessmentPartQuery` is available.
Return	`boolean`		`true` if an assessment part query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentAssessmentPartQuery
Description	Gets the query for an assessment part. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.authoring.AssessmentPartQuery`		the assessment part query
Errors	UNIMPLEMENTED		`supportsParentAssessmentPartQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParentAssessmentPartQuery()` is `true`.
Method	matchAnyParentAssessmentPart
Description	Matches assessment parts with any parent assessment part.
Parameters	`boolean`	`match`	`true` to match assessment parts with any parent, `false` to match assessment parts with no parents
Compliance	`mandatory`		This method must be implemented.
Method	clearParentAssessmentPartTerms
Description	Clears all assessment part terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSection
Description	Matches assessment parts that are also used as sections.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearSectionTerms
Description	Clears all section terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWeight
Description	Matches assessment parts that fall in between the given weights inclusive.
Parameters	`cardinal`	`low`	low end of range
	`cardinal`	`high`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyWeight
Description	Matches assessment parts with any weight assigned.
Parameters	`boolean`	`match`	`true` to match assessment parts with any wieght, `false` to match assessment parts with no weight
Compliance	`mandatory`		This method must be implemented.
Method	clearWeightTerms
Description	Clears all weight terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAllocatedTime
Description	Matches assessment parts hose allocated time falls in between the given times inclusive.
Parameters	`osid.calendaring.Duration`	`low`	low end of range
	`osid.calendaring.Duration`	`high`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAllocatedTime
Description	Matches assessment parts with any time assigned.
Parameters	`boolean`	`match`	`true` to match assessment parts with any alloocated time, `false` to match assessment parts with no allocated time
Compliance	`mandatory`		This method must be implemented.
Method	clearAllocatedTimeTerms
Description	Clears all allocated time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchChildAssessmentPartId
Description	Sets the assessment part `Id` for this query.
Parameters	`osid.id.Id`	`assessmentPartId`	an assessment part `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentPartId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearChildAssessmentPartIdTerms
Description	Clears all assessment part `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsChildAssessmentPartQuery
Description	Tests if an `AssessmentPartQuery` is available.
Return	`boolean`		`true` if an assessment part query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getChildAssessmentPartQuery
Description	Gets the query for an assessment part. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.authoring.AssessmentPartQuery`		the assessment part query
Errors	UNIMPLEMENTED		`supportsChildAssessmentPartQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChildAssessmentPartQuery()` is `true`.
Method	matchAnyChildAssessmentPart
Description	Matches assessment parts with any child assessment part.
Parameters	`boolean`	`match`	`true` to match assessment parts with any children, `false` to match assessment parts with no children
Compliance	`mandatory`		This method must be implemented.
Method	clearChildAssessmentPartTerms
Description	Clears all assessment part terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankId
Description	Matches constrainers mapped to the bank.
Parameters	`osid.id.Id`	`bankId`	the 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	clearBankIdTerms
Description	Clears the bank `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBankQuery
Description	Tests if an `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 the bank query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartQueryRecord
Description	Gets the assessment part query record corresponding to the given `AssessmentPart` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assessmentPartRecordType`	an assessment part record type
Return	`osid.assessment.authoring.records.AssessmentPartQueryRecord`		the assessment part query record
Errors	NULL_ARGUMENT		`assessmentPartRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentPartRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.