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

Interface	osid.course.program.ProgramOfferingQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.course.program.EnrollmentQuery`
	`osid.course.program.ProgramOfferingQuery`
	`osid.course.program.ProgramOfferingQuerySession`
	`osid.course.program.ProgramOfferingSearchSession`
	`osid.course.program.ProgramOfferingSmartCourseCatalogSession`
Description	This is the query for searching program offerings. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchProgramId
Description	Sets the program `Id` for this query to match program offerings that have a related program.
Parameters	`osid.id.Id`	`programId`	a program `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramIdTerms
Description	Clears the program `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramQuery
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	getProgramQuery
Description	Gets the query for a program. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramQuery`		the program query
Errors	UNIMPLEMENTED		`supportsProgramQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramQuery()` is `true`.
Method	clearProgramTerms
Description	Clears the program terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTermId
Description	Sets the term `Id` for this query to match program offerings that have a related term.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`termId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTermIdTerms
Description	Clears the term `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a term query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTermQuery
Description	Gets the query for a reporting term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		the term query
Errors	UNIMPLEMENTED		`supportsTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTermQuery()` is `true`.
Method	clearTermTerms
Description	Clears the reporting term terms.
Compliance	`mandatory`		This method must be implemented.
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 program offerings with any title, `false` to match program offerings 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 program number for this query.
Parameters	`string`	`number`	program 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 program number that has any value.
Parameters	`boolean`	`match`	`true` to match program offerings with any number, `false` to match program offerings with no number
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	matchParentProgramOfferingId
Description	Sets the parent program offering `Id` for this query.
Parameters	`osid.id.Id`	`programOfferingId`	a program offering `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`programOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentProgramOfferingIdTerms
Description	Clears the parent program offering `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParentProgramOfferingQuery
Description	Tests if a `ProgramOfferingQuery` is available.
Return	`boolean`		`true` if a program offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramOfferingQuery
Description	Gets the query for a parent program offering. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramOfferingQuery`		a parent program offering query
Errors	UNIMPLEMENTED		`supportsParentProgramOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParentProgramOfferingQuery()` is `true`.
Method	matchAnyParentProgramOffering
Description	Matches program offerings that are part of any parent.
Parameters	`boolean`	`match`	`true` to match program offerings that are part of a parent, `false` to match program offerings with no parent
Compliance	`mandatory`		This method must be implemented.
Method	clearParentProgramOfferingTerms
Description	Clears the parent program offering 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 objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
Description	Tests if a `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`		an objective query
Errors	UNIMPLEMENTED		`supportsLearningObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true`.
Method	matchAnyLearningObjective
Description	Matches program offerings that have any learning objective.
Parameters	`boolean`	`match`	`true` to match program offerings with any learning objective, `false` to match program offerings 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	matchRestrictedAudienceId
Description	Sets the resource `Id` for this query to match program offerings that have a restricted 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	clearRestrictedAudienceIdTerms
Description	Clears the restricted audience `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRestrictedAudienceQuery
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	getRestrictedAudienceQuery
Description	Gets the query for a restricted audience. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsRestrictedAudienceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRestrictedAudienceQuery()` is `true`.
Method	matchAnyRestrictedAudience
Description	Matches program offerings that have any restricted audience.
Parameters	`boolean`	`match`	`true` to match program offerings with any restricted audience, `false` to match program offerings with no restricted audiences
Compliance	`mandatory`		This method must be implemented.
Method	clearRestrictedAudienceTerms
Description	Clears the restricted 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	matchRequiresRegistration
Description	Matches program offerings that require registration.
Parameters	`boolean`	`match`	`true` to match program offerings requiring registration,, `false` to match program offerings not requiring registration
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresRegistrationTerms
Description	Clears the requires registration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumSeats
Description	Matches program offerings with minimum seating between the given numbers inclusive.
Parameters	`cardinal`	`min`	low number
	`cardinal`	`max`	high number
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumSeats
Description	Matches a program offering that has any minimum seating assigned.
Parameters	`boolean`	`match`	`true` to match program offerings with any minimum seats, `false` to match program offerings with no minimum seats
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumSeatsTerms
Description	Clears the minimum seats terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMaximumSeats
Description	Matches program offerings with maximum seating between the given numbers inclusive.
Parameters	`cardinal`	`min`	low number
	`cardinal`	`max`	high number
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMaximumSeats
Description	Matches a program offering that has any maximum seating assigned.
Parameters	`boolean`	`match`	`true` to match program offerings with any maximum seats, `false` to match program offerings with no maximum seats
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumSeatsTerms
Description	Clears the maximum seats terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchURL
Description	Adds a class url for this query.
Parameters	`string`	`url`	url 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		`url` not of `stringMatchType`
	NULL_ARGUMENT		`url` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyURL
Description	Matches a url that has any value.
Parameters	`boolean`	`match`	`true` to match program offerings with any url, `false` to match program offerings with no url
Compliance	`mandatory`		This method must be implemented.
Method	clearURLTerms
Description	Clears the url terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match program offerings 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	getProgramOfferingQueryRecord
Description	Gets the program offering query record corresponding to the given `ProgramOffering` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`programOfferingRecordType`	a program offering record type
Return	`osid.course.program.records.ProgramOfferingQueryRecord`		the program offering query record
Errors	NULL_ARGUMENT		`programOfferingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programOfferingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.