OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Credential objects. The search query is constructed using the CredentialQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include credentials in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to credentials in this course catalog

Credentials may have a query record indicated by their respective record types. The query record is accessed via the CredentialQuery.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchCredentials
Description

Tests if this user can perform Credential searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
Description

Federates the view for methods in this session. A federated view will include credentials in course catalog which are children of this course catalog in the course catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodgetCredentialQuery
Description

Gets a credential query.

Returnosid.course.program.CredentialQuerythe credential query
CompliancemandatoryThis method must be implemented.
MethodgetCredentialsByQuery
Description

Gets a list of Credentials matching the given credential query.

Parametersosid.course.program.CredentialQuerycredentialQuerythe credential query
Returnosid.course.program.CredentialListthe returned CredentialList
ErrorsNULL_ARGUMENT credentialQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED credentialQuery is not of this service
CompliancemandatoryThis method must be implemented.