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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CredentialQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Credentials. The credentials may be sequenced using the CredentialSearchOrder from this session.

This CourseCatalog has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a CredentialQueryInspector. The query may be modified by converting the inspector back to a 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.
MethodcanManageSmartCourseCatalogs
Description

Tests if this user can manage smart course catalogs. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart course catalog management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCredentialQuery
Description

Gets a credential query.

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

Gets a credential search order.

Returnosid.course.program.CredentialSearchOrderthe credential search order
CompliancemandatoryThis method must be implemented.
MethodapplyCredentialQuery
Description

Applies a credential query to this course catalog.

Parametersosid.course.program.CredentialQuerycredentialQuerythe credential query
ErrorsNULL_ARGUMENT credentialQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED credentialQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCredentialQuery
Description

Gets a credential query inspector for this course catalog.

Returnosid.course.program.CredentialQueryInspectorthe credential query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCredentialSequencing
Description

Applies a credential search order to this course catalog.

Parametersosid.course.program.CredentialSearchOrdercredentialSearchOrderthe credential search order
ErrorsNULL_ARGUMENT credentialSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED credentialSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCredentialQueryFromInspector
Description

Gets a credential query from an inspector.

Parametersosid.course.program.CredentialQueryInspectorcredentialQueryInspectora query inspector
Returnosid.course.program.CredentialQuerythe credential query
ErrorsNULL_ARGUMENT credentialQueryInspector is null
UNSUPPORTED credentialQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.