OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
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.

MethodmatchTitle
Description

Adds a title for this query.

Parametersstringtitletitle string to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT title not of stringMatchType
NULL_ARGUMENT title or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTitle
Description

Matches a title that has any value.

Parametersbooleanmatch true to match programs with any title, false to match programs with no title
CompliancemandatoryThis method must be implemented.
MethodclearTitleTerms
Description

Clears the title terms.

CompliancemandatoryThis method must be implemented.
MethodmatchNumber
Description

Adds a programs number for this query.

Parametersstringnumberprograms number string to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT number not of stringMatchType
NULL_ARGUMENT number or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyNumber
Description

Matches a programs number that has any value.

Parametersbooleanmatch true to match programs with any number, false to match programs with no title
CompliancemandatoryThis method must be implemented.
MethodclearNumberTerms
Description

Clears the number terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSponsorId
Description

Sets the resource Id for this query to match programs that have a sponsor.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearSponsorIdTerms
Description

Clears the sponsor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSponsorQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSponsorQuery
Description

Gets the query for a sponsor. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerya resource query
ErrorsUNIMPLEMENTED supportsSponsorQuery() is false
ComplianceoptionalThis method must be implemented if supportsSponsorQuery() is true.
MethodmatchAnySponsor
Description

Matches programs that have any sponsor.

Parametersbooleanmatch true to match programs with any sponsor, false to match programs with no sponsors
CompliancemandatoryThis method must be implemented.
MethodclearSponsorTerms
Description

Clears the sponsor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCompletionRequirementsInfo
Description

Matches programs with the prerequisites informational string.

ParametersstringrequirementsInfocompletion requirements string to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT requirementsInfo not of stringMatchType
NULL_ARGUMENT requirementsInfo or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCompletionRequirementsInfo
Description

Matches a program that has any completion requirements information assigned.

Parametersbooleanmatch true to match programs with any completion requirements information, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearCompletionRequirementsInfoTerms
Description

Clears the completion requirements info terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCompletionRequirementsId
Description

Sets the requisite Id for this query.

Parametersosid.id.IdruleIda rule Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT ruleId is null
CompliancemandatoryThis method must be implemented.
MethodclearCompletionRequirementsIdTerms
Description

Clears the requisite Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCompletionRequirementsQuery
Description

Tests if a RequisiteQuery is available.

Returnboolean true if a requisite query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCompletionRequirementsQuery
Description

Gets the query for a requisite. Multiple retrievals produce a nested OR term.

Returnosid.course.requisite.RequisiteQuerya requisite query
ErrorsUNIMPLEMENTED supportsCompletionRequirementsQuery() is false
ComplianceoptionalThis method must be implemented if supportsCompletionRequirementsQuery() is true.
MethodmatchAnyCompletionRequirements
Description

Matches programs that have any completion requirement requisite.

Parametersbooleanmatch true to match programs with any requisite, false to match programs with no requisites
CompliancemandatoryThis method must be implemented.
MethodclearCompletionRequirementsTerms
Description

Clears the requisite terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCredentialId
Description

Sets the credential Id for this query.

Parametersosid.id.IdcredentialIda credential Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT credentialId is null
CompliancemandatoryThis method must be implemented.
MethodclearCredentialIdTerms
Description

Clears the credential Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialQuery
Description

Tests if a CredentialQuery is available.

Returnboolean true if a credential query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCredentialQuery
Description

Gets the query for a credential. Multiple retrievals produce a nested OR term.

Returnosid.course.program.CredentialQuerya credential query
ErrorsUNIMPLEMENTED supportsCredentialQuery() is false
ComplianceoptionalThis method must be implemented if supportsCredentialQuery() is true.
MethodmatchAnyCredential
Description

Matches programs that have any credentials.

Parametersbooleanmatch true to match programs with any credentials, false to match programs with no credentials
CompliancemandatoryThis method must be implemented.
MethodclearCredentialTerms
Description

Clears the credential terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProgramOfferingId
Description

Sets the program offering Id for this query to match programs that have a related program offering.

Parametersosid.id.IdprogramOfferingIda program offering Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT programOfferingId is null
CompliancemandatoryThis method must be implemented.
MethodclearProgramOfferingIdTerms
Description

Clears the program offering Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingQuery
Description

Tests if a ProgramOfferingQuery is available.

Returnboolean true if a program offering query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingQuery
Description

Gets the query for a program offering. Multiple retrievals produce a nested OR term.

Returnosid.course.program.ProgramOfferingQuerythe program offering query
ErrorsUNIMPLEMENTED supportsProgramOfferingQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingQuery() is true.
MethodmatchAnyProgramOffering
Description

Matches programs that have any program offering.

Parametersbooleanmatch true to match programs with any program offering, false to match programs with no program offering
CompliancemandatoryThis method must be implemented.
MethodclearProgramOfferingTerms
Description

Clears the program offering terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match programs assigned to course catalogs.

Parametersosid.id.IdcourseCatalogIdthe course catalog Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseCatalogIdTerms
Description

Clears the course catalog Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

Returnboolean true if a course catalog query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogQuery
Description

Gets the query for a course catalog. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseCatalogQuerythe course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

CompliancemandatoryThis method must be implemented.
MethodgetProgramQueryRecord
Description

Gets the program query record corresponding to the given Program record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeprogramRecordTypea programs record type
Returnosid.course.program.records.ProgramQueryRecordthe program query record
ErrorsNULL_ARGUMENT programRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programRecordType) is false
CompliancemandatoryThis method must be implemented.