OSID - osid.course.program.ProgramQuery Service Interface Definition

Interface	osid.course.program.ProgramQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidOperableQuery`
Used By	`osid.course.chronicle.AssessmentEntryQuery`
	`osid.course.chronicle.AwardEntryQuery`
	`osid.course.chronicle.CredentialEntryQuery`
	`osid.course.chronicle.ProgramEntryQuery`
	`osid.course.program.CredentialQuery`
	`osid.course.program.ProgramOfferingQuery`
	`osid.course.program.ProgramQuery`
	`osid.course.program.ProgramQuerySession`
	`osid.course.program.ProgramSearchSession`
	`osid.course.program.ProgramSmartCourseCatalogSession`
	show 1 more…
`osid.course.requisite.RequisiteQuery`
Description	This is the query for searching programs. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchTitle
Description	Adds a title for this query.
Parameters	`string`	`title`	title string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`title` not of `stringMatchType`
	NULL_ARGUMENT		`title` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTitle
Description	Matches a title that has any value.
Parameters	`boolean`	`match`	`true` to match programs with any title, `false` to match programs with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearTitleTerms
Description	Clears the title terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNumber
Description	Adds a programs number for this query.
Parameters	`string`	`number`	programs number string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` not of `stringMatchType`
	NULL_ARGUMENT		`number` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyNumber
Description	Matches a programs number that has any value.
Parameters	`boolean`	`match`	`true` to match programs with any number, `false` to match programs with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearNumberTerms
Description	Clears the number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSponsorId
Description	Sets the resource `Id` for this query to match programs that have a sponsor.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsorIdTerms
Description	Clears the sponsor `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSponsorQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorQuery
Description	Gets the query for a sponsor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsSponsorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSponsorQuery()` is `true`.
Method	matchAnySponsor
Description	Matches programs that have any sponsor.
Parameters	`boolean`	`match`	`true` to match programs with any sponsor, `false` to match programs with no sponsors
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsorTerms
Description	Clears the sponsor terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchParentProgramId
Description	Sets the parent program `Id` for this query.
Parameters	`osid.id.Id`	`ruleId`	a rule `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ruleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentProgramIdTerms
Description	Clears the parent program `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParentProgramQuery
Description	Tests if a `ProgramQuery` is available.
Return	`boolean`		`true` if a program query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramQuery
Description	Gets the query for a parent program. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramQuery`		a parent program query
Errors	UNIMPLEMENTED		`supportsParentProgramQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParentProgramQuery()` is `true`.
Method	matchAnyParentProgram
Description	Matches programs that have any parent.
Parameters	`boolean`	`match`	`true` to match programs with parent, `false` to match programs with no parent
Compliance	`mandatory`		This method must be implemented.
Method	clearParentProgramTerms
Description	Clears the parent program terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLearningObjectiveId
Description	Sets the objective `Id` for this query.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`objectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveIdTerms
Description	Clears the learning objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
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	getLearningObjectiveQuery
Description	Gets the query for a learning objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		a learning objective query
Errors	UNIMPLEMENTED		`supportsLearningObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true`.
Method	matchAnyLearningObjective
Description	Matches programs that have any learning objective.
Parameters	`boolean`	`match`	`true` to match programs with any learning objective, `false` to match programs with no learning objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveTerms
Description	Clears the learning objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTargetAudienceId
Description	Sets the resource `Id` for this query to match programs that have a target audience.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetAudienceIdTerms
Description	Clears the target audience `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTargetAudienceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetAudienceQuery
Description	Gets the query for a target audience. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsTargetAudienceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTargetAudienceQuery()` is `true`.
Method	matchAnyTargetAudience
Description	Matches programs that have any target audience.
Parameters	`boolean`	`match`	`true` to match programs with any target audience, `false` to match programs with no target audiences
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetAudienceTerms
Description	Clears the target audience terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompletionRequirementsInfo
Description	Matches programs with the prerequisites informational string.
Parameters	`string`	`requirementsInfo`	completion requirements string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`requirementsInfo` not of `stringMatchType`
	NULL_ARGUMENT		`requirementsInfo` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCompletionRequirementsInfo
Description	Matches a program that has any completion requirements information assigned.
Parameters	`boolean`	`match`	`true` to match programs with any completion requirements information, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionRequirementsInfoTerms
Description	Clears the completion requirements info terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompletionRequirementsId
Description	Sets the requisite `Id` for this query.
Parameters	`osid.id.Id`	`ruleId`	a rule `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ruleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionRequirementsIdTerms
Description	Clears the requisite `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompletionRequirementsQuery
Description	Tests if a `RequisiteQuery` is available.
Return	`boolean`		`true` if a requisite query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionRequirementsQuery
Description	Gets the query for a requisite. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.requisite.RequisiteQuery`		a requisite query
Errors	UNIMPLEMENTED		`supportsCompletionRequirementsQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompletionRequirementsQuery()` is `true`.
Method	matchAnyCompletionRequirements
Description	Matches programs that have any completion requirement requisite.
Parameters	`boolean`	`match`	`true` to match programs with any requisite, `false` to match programs with no requisites
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionRequirementsTerms
Description	Clears the requisite terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCredentialId
Description	Sets the credential `Id` for this query.
Parameters	`osid.id.Id`	`credentialId`	a credential `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`credentialId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCredentialIdTerms
Description	Clears the credential `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialQuery
Description	Tests if a `CredentialQuery` is available.
Return	`boolean`		`true` if a credential query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialQuery
Description	Gets the query for a credential. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.CredentialQuery`		a credential query
Errors	UNIMPLEMENTED		`supportsCredentialQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCredentialQuery()` is `true`.
Method	matchAnyCredential
Description	Matches programs that have any credentials.
Parameters	`boolean`	`match`	`true` to match programs with any credentials, `false` to match programs with no credentials
Compliance	`mandatory`		This method must be implemented.
Method	clearCredentialTerms
Description	Clears the credential terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match programs assigned to course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	the course catalog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseCatalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseCatalogIdTerms
Description	Clears the course catalog `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if a `CourseCatalogQuery` is available.
Return	`boolean`		`true` if a course catalog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogQuery
Description	Gets the query for a course catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseCatalogQuery`		the course catalog query
Errors	UNIMPLEMENTED		`supportsCourseCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseCatalogQuery()` is `true`.
Method	clearCourseCatalogTerms
Description	Clears the course catalog terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProgramQueryRecord
Description	Gets the program query record corresponding to the given `Program` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`programRecordType`	a programs record type
Return	`osid.course.program.records.ProgramQueryRecord`		the program query record
Errors	NULL_ARGUMENT		`programRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.