OSID - osid.learning.ObjectiveBankQuery Service Interface Definition

Interface	osid.learning.ObjectiveBankQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.learning.ActivityQuery`
	`osid.learning.ObjectiveBankQuery`
	`osid.learning.ObjectiveBankQuerySession`
	`osid.learning.ObjectiveBankSearchSession`
	`osid.learning.ObjectiveQuery`
	`osid.learning.ProficiencyQuery`
Description	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`.
Method	matchObjectiveId
Description	Sets the objective `Id` for this query.
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	clearObjectiveIdTerms
Description	Clears the objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveQuery
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	getObjectiveQuery
Description	Gets the query for an objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsObjectiveQuery()` is `true`.
Method	matchAnyObjective
Description	Matches an objective bank that has any objective assigned.
Parameters	`boolean`	`match`	`true` to match objective banks with any objective, `false` to match objective banks with no objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearObjectiveTerms
Description	Clears the objective 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 a `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 bank that has any activity assigned.
Parameters	`boolean`	`match`	`true` to match objective banks with any activity, `false` to match objective banks with no activities
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorObjectiveBankId
Description	Sets the objective bank `Id` for this query to match objective banks that have the specified objective bank as an ancestor.
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	clearAncestorObjectiveBankIdTerms
Description	Clears the ancestor objective bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorObjectiveBankQuery
Description	Tests if a `ObjectiveBankQuery` is available for querying ancestor objective banks.
Return	`boolean`		`true` if an objective bank query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorObjectiveBankQuery
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		`supportsAncestorObjectiveBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCalndarQuery()` is `true`.
Method	matchAnyAncestorObjectiveBank
Description	Matches an objective bank that has any ancestor.
Parameters	`boolean`	`match`	`true` to match objective banks with any ancestor, `false` to match root objective banks
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorObjectiveBankTerms
Description	Clears the ancestor objective bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantObjectiveBankId
Description	Sets the objective bank `Id` for this query to match objective banks that have the specified objective bank as a descendant.
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	clearDescendantObjectiveBankIdTerms
Description	Clears the descendant objective bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantObjectiveBankQuery
Description	Tests if a `ObjectiveBankQuery` is available for querying descendant objective banks.
Return	`boolean`		`true` if an objective bank query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantObjectiveBankQuery
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		`supportsDescendantObjectiveBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCalndarQuery()` is `true`.
Method	matchAnyDescendantObjectiveBank
Description	Matches an objective bank that has any descendant.
Parameters	`boolean`	`match`	`true` to match objective banks with any descendant, `false` to match leaf objective banks
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantObjectiveBankTerms
Description	Clears the descendant objective bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBankQueryRecord
Description	Gets the objective bank query record corresponding to the given `ObjectiveBank` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`objectiveBankRecordType`	an objective bank record type
Return	`osid.learning.records.ObjectiveBankQueryRecord`		the objective bank query record
Errors	NULL_ARGUMENT		`objectiveBankRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(objectiveBankRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.