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

This session provides methods for retrieving CourseCatalog objects. The CourseCatalog represents a collection of courses, offerings and tems.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the CourseCatalogs it can access, without breaking execution. However, an assessment may only be useful if all CourseCatalogs referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupCourseCatalogs
Description

Tests if this user can perform CourseCatalog lookups. 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 lookup operations to unauthorized users.

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

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCourseCatalogView
Description

A complete view of the CourseCatalog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CourseCatalog may have a different Id than requested, such as the case where a duplicate Id was assigned to a CourseCatalog and retained for compatibility.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.course.CourseCatalogthe course catalog
ErrorsNOT_FOUND courseCatalogId not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCourseCatalogsByIds
Description

Gets a CourseCatalogList corresponding to the given IdList. In plenary mode, the returned list contains all of the course catalogs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CourseCatalogs may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcourseCatalogIdsthe list of Ids to retrieve
Returnosid.course.CourseCatalogListthe returned CourseCatalog list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByGenusType
Description

Gets a CourseCatalogList corresponding to the given course catalog genus Type which does not include course catalogs of types derived from the specified Type. In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.

Parametersosid.type.TypecourseCatalogGenusTypea course catalog genus type
Returnosid.course.CourseCatalogListthe returned CourseCatalog list
ErrorsNULL_ARGUMENT courseCatalogGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByParentGenusType
Description

Gets a CourseCatalogList corresponding to the given course catalog genus Type and include any additional course catalogs with genus types derived from the specified Type. In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.

Parametersosid.type.TypecourseCatalogGenusTypea course catalog genus type
Returnosid.course.CourseCatalogListthe returned CourseCatalog list
ErrorsNULL_ARGUMENT courseCatalogGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByRecordType
Description

Gets a CourseCatalogList containing the given course catalog record Type. In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.

Parametersosid.type.TypecourseCatalogRecordTypea course catalog record type
Returnosid.course.CourseCatalogListthe returned CourseCatalog list
ErrorsNULL_ARGUMENT courseCatalogRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByProvider
Description

Gets a CourseCatalogList from the given provider. In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.course.CourseCatalogListthe returned CourseCatalog list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogs
Description

Gets all CourseCatalogs. In plenary mode, the returned list contains all known course catalogs or an error results. Otherwise, the returned list may contain only those course catalogs that are accessible through this session.

Returnosid.course.CourseCatalogLista list of CourseCatalogs
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.