OSID - osid.learning.ActivityQuery Service Interface Definition

Interface	osid.learning.ActivityQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.learning.ActivityQuerySession`
	`osid.learning.ActivitySearchSession`
	`osid.learning.ActivitySmartObjectiveBankSession`
	`osid.learning.ObjectiveBankQuery`
	`osid.learning.ObjectiveQuery`
Description	This is the query for searching activities. Each method match request produces an `AND` term while multiple invocations of a method produces 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 for querying objectives.
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	clearObjectiveTerms
Description	Clears the objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssetId
Description	Sets the asset `Id` for this query.
Parameters	`osid.id.Id`	`assetId`	an asset `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetIdTerms
Description	Clears the asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
Description	Tests if an `AssetQuery` is available for querying objectives.
Return	`boolean`		`true` if an asset query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAssetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsObjectiveQuery()` is `true`.
Method	matchAnyAsset
Description	Matches an activity that has any objective assigned.
Parameters	`boolean`	`match`	`true` to match activities with any asset, `false` to match activities with no asset
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetTerms
Description	Clears the asset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseId
Description	Sets the course `Id` for this query.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseIdTerms
Description	Clears the course `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseQuery
Description	Tests if a `CourseQuery` is available for querying courses.
Return	`boolean`		`true` if a course query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQuery
Description	Gets the query for a course. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseQuery`		the course query
Errors	UNIMPLEMENTED		`supportsCourseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseQuery()` is `true`.
Method	matchAnyCourse
Description	Matches an activity that has any course assigned.
Parameters	`boolean`	`match`	`true` to match activities with any courses, `false` to match activities with no courses
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseTerms
Description	Clears the course 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 the assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if an `AssessmentQuery` is available for querying assessments.
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 activity that has any assessment assigned.
Parameters	`boolean`	`match`	`true` to match activities with any assessments, `false` to match activities with no assessments
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears the assessment 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 resources.
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	getActivityQueryRecord
Description	Gets the activity query record corresponding to the given `Activity` record `Type` .Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`activityRecordType`	an activity query record type
Return	`osid.learning.records.ActivityQueryRecord`		the activity query record
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(activityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.