OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching credentials. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchLifetime
Description

Matches lifetimes between the given range inclusive.

Parametersosid.calendaring.Durationlowstart of range
osid.calendaring.Durationhighend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyLifetime
Description

Matches credentials that have any lifetime.

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

Clears the lifetime Id terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProgramId
Description

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

Parametersosid.id.IdprogramIda program Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT programId is null
CompliancemandatoryThis method must be implemented.
MethodclearProgramIdTerms
Description

Clears the program Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProgramQuery
Description

Tests if a ProgramQuery is available.

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

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

Returnosid.course.program.ProgramQuerythe program query
ErrorsUNIMPLEMENTED supportsProgramQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramQuery() is true.
MethodmatchAnyProgram
Description

Matches credentials that have any program.

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

Clears the program terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match credentials 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.
MethodgetCredentialQueryRecord
Description

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

Parametersosid.type.TypecredentialRecordTypea credential record type
Returnosid.course.program.records.CredentialQueryRecordthe credential query record
ErrorsNULL_ARGUMENT credentialRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialRecordType) is false
CompliancemandatoryThis method must be implemented.