Interface | osid.course.program.CredentialQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching credentials. Each method
match specifies an | ||
Method | matchLifetime | ||
Description |
Matches lifetimes between the given range inclusive. | ||
Parameters | osid.calendaring.Duration | low | start of range |
osid.calendaring.Duration | high | end of range | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
NULL_ARGUMENT | low or high is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyLifetime | ||
Description |
Matches credentials that have any lifetime. | ||
Parameters | boolean | match | true to match credentials with any lifetime, false
to match credentials with no lifetime |
Compliance | mandatory | This method must be implemented. | |
Method | clearLifetimeTerms | ||
Description |
Clears the lifetime | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProgramId | ||
Description |
Sets the program | ||
Parameters | osid.id.Id | programId | a program Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProgramQuery | ||
Description |
Tests if a | ||
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 | ||
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 | matchAnyProgram | ||
Description |
Matches credentials that have any program. | ||
Parameters | boolean | match | true to match credentials with any related program,
false to match credentials with no programs |
Compliance | mandatory | This method must be implemented. | |
Method | clearProgramTerms | ||
Description |
Clears the program 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 | getCredentialQueryRecord | ||
Description |
Gets the credential query record corresponding to the
given | ||
Parameters | osid.type.Type | credentialRecordType | a credential record type |
Return | osid.course.program.records.CredentialQueryRecord | the credential query record | |
Errors | NULL_ARGUMENT | credentialRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(credentialRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |