OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CourseProgramProfile
Implementsosid.OsidProfile
Description

The course program profile describes the interoperability among course program services.

MethodsupportsVisibleFederation
Description

Tests if any course catalog federation is exposed. Federation is exposed when a specific course catalog may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramLookup
Description

Tests if looking up programs is supported.

Returnboolean true if program lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramQuery
Description

Tests if querying programs is supported.

Returnboolean true if program query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramSearch
Description

Tests if searching programs is supported.

Returnboolean true if program search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramAdmin
Description

Tests if program administrative service is supported.

Returnboolean true if program administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramNotification
Description

Tests if a program notification service is supported.

Returnboolean true if program notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramCourseCatalog
Description

Tests if a program cataloging service is supported.

Returnboolean true if program cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramCourseCatalogAssignment
Description

Tests if a course cataloging service is supported. A course cataloging service maps programs to catalogs.

Returnboolean true if course cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramSmartCourseCatalog
Description

Tests if a program smart course catalog session is available.

Returnboolean true if a program smart course catalog session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseProgramLookup
Description

Tests if a course/program lookup service is supported.

Returnboolean true if course/program lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseProgramAssignment
Description

Tests if a course/program mapping service is supported.

Returnboolean true if course/program mapping service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingLookup
Description

Tests if looking up program offerings is supported.

Returnboolean true if program offering lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingQuery
Description

Tests if querying program offerings is supported.

Returnboolean true if program offering query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingSearch
Description

Tests if searching program offerings is supported.

Returnboolean true if program offering search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingAdmin
Description

Tests if course offering administrative service is supported.

Returnboolean true if program offering administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingNotification
Description

Tests if a program offering notification service is supported.

Returnboolean true if program offering notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingCourseCatalog
Description

Tests if a program offering cataloging service is supported.

Returnboolean true if program offering catalog is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingCourseCatalogAssignment
Description

Tests if a program offering cataloging service is supported. A cataloging service maps program offerings to catalogs.

Returnboolean true if program offering cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingSmartCourseCatalog
Description

Tests if a program offering smart course catalog session is available.

Returnboolean true if a program offering smart course catalog session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialLookup
Description

Tests if looking up courses is supported.

Returnboolean true if course lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialQuery
Description

Tests if querying courses is supported.

Returnboolean true if credential query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialSearch
Description

Tests if searching courses is supported.

Returnboolean true if credential search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialAdmin
Description

Tests if course administrative service is supported.

Returnboolean true if course administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialNotification
Description

Tests if a course notification service is supported.

Returnboolean true if course notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialCourseCatalog
Description

Tests if a course cataloging service is supported.

Returnboolean true if course cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialCourseCatalogAssignment
Description

Tests if a course cataloging service is supported. A course cataloging service maps courses to catalogs.

Returnboolean true if course cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialSmartCourseCatalog
Description

Tests if a credential smart course catalog session is available.

Returnboolean true if a credential smart course catalog session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentLookup
Description

Tests if looking up enrollments is supported.

Returnboolean true if enrollment lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentQuery
Description

Tests if querying enrollments is supported.

Returnboolean true if enrollment query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentSearch
Description

Tests if searching enrollments is supported.

Returnboolean true if enrollment search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentAdmin
Description

Tests if an enrollment administrative service is supported.

Returnboolean true if enrollment administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentNotification
Description

Tests if an enrollment notification service is supported.

Returnboolean true if enrollment notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentCourseCatalog
Description

Tests if an enrollment cataloging service is supported.

Returnboolean true if enrollment catalog is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentCourseCatalogAssignment
Description

Tests if an enrollment cataloging service is supported. A cataloging service maps enrollments to catalogs.

Returnboolean true if enrollment cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentSmartCourseCatalog
Description

Tests if an enrollment smart course catalog session is available.

Returnboolean true if an enrollment smart course catalog session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseProgramBatch
Description

Tests if a course program batch service is available.

Returnboolean true if a course program batch service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramRecordTypes
Description

Gets the supported program record types.

Returnosid.type.TypeLista list containing the supported Program record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramRecordType
Description

Tests if the given program record type is supported.

Parametersosid.type.TypeprogramRecordTypea Type indicating a program record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT programRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProgramSearchRecordTypes
Description

Gets the supported program search record types.

Returnosid.type.TypeLista list containing the supported program search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramSearchRecordType
Description

Tests if the given program search record type is supported.

Parametersosid.type.TypeprogramSearchRecordTypea Type indicating a Program search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT programSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingRecordTypes
Description

Gets the supported ProgramOffering record types.

Returnosid.type.TypeLista list containing the supported ProgramOffering record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingRecordType
Description

Tests if the given ProgramOffering record type is supported.

Parametersosid.type.TypeprogramOfferingRecordTypea Type indicating an ProgramOffering record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT programOfferingRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingSearchRecordTypes
Description

Gets the supported ProgramOffering search record types.

Returnosid.type.TypeLista list containing the supported ProgramOffering search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramOfferingSearchRecordType
Description

Tests if the given ProgramOffering search record type is supported.

Parametersosid.type.TypeprogramOfferingSearchRecordTypea Type indicating an ProgramOffering search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT programOfferingSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRecordTypes
Description

Gets the supported credential record types.

Returnosid.type.TypeLista list containing the supported credential record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialRecordType
Description

Tests if the given credential record type is supported.

Parametersosid.type.TypecredentialRecordTypea Type indicating a credential record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT credentialRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCredentialSearchRecordTypes
Description

Gets the supported credential search record types.

Returnosid.type.TypeLista list containing the supported credential search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialSearchRecordType
Description

Tests if the given credential search record type is supported.

Parametersosid.type.TypecredentialSearchRecordTypea Type indicating a credential search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT credentialSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentRecordTypes
Description

Gets the supported Enrollment record types.

Returnosid.type.TypeLista list containing the supported Enrollment record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentRecordType
Description

Tests if the given Enrollment record type is supported.

Parametersosid.type.TypeenrollmentRecordTypea Type indicating an Enrollment record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT enrollmentRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentSearchRecordTypes
Description

Gets the supported Enrollment search record types.

Returnosid.type.TypeLista list containing the supported Enrollment search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEnrollmentSearchRecordType
Description

Tests if the given Enrollment search record type is supported.

Parametersosid.type.TypeenrollmentSearchRecordTypea Type indicating an Enrollment search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT enrollmentSearchRecordType is null
CompliancemandatoryThis method must be implemented.