Interface | osid.course.program.ProgramQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidOperableQuery | |||
Description |
This is the query for searching programs. Each method match
specifies an | ||
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 | ||
Parameters | osid.id.Id | resourceId | a resource Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSponsorQuery | ||
Description |
Tests if a | ||
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 | ||
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 | 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 | ||
Parameters | osid.id.Id | ruleId | a rule Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCompletionRequirementsQuery | ||
Description |
Tests if a | ||
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 | ||
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 | ||
Parameters | osid.id.Id | credentialId | a credential Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCredentialQuery | ||
Description |
Tests if a | ||
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 | ||
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 | matchProgramOfferingId | ||
Description |
Sets the program offering | ||
Parameters | osid.id.Id | programOfferingId | a program offering Id |
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 | clearProgramOfferingIdTerms | ||
Description |
Clears the program offering | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProgramOfferingQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a program offering query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingQuery | ||
Description |
Gets the query for a program offering. Multiple
retrievals produce a nested | ||
Return | osid.course.program.ProgramOfferingQuery | the program offering query | |
Errors | UNIMPLEMENTED | supportsProgramOfferingQuery() is false | |
Compliance | optional | This method must be implemented if supportsProgramOfferingQuery()
is true. | |
Method | matchAnyProgramOffering | ||
Description |
Matches programs that have any program offering. | ||
Parameters | boolean | match | true to match programs with any program offering,
false to match programs with no program offering |
Compliance | mandatory | This method must be implemented. | |
Method | clearProgramOfferingTerms | ||
Description |
Clears the program offering terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseCatalogId | ||
Description |
Sets the course catalog | ||
Parameters | osid.id.Id | courseCatalogId | the course catalog Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseCatalogQuery | ||
Description |
Tests if a | ||
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 | ||
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 | ||
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. |