OSID - osid.course.program.CourseProgramProfile Service Interface Definition

Interface	osid.course.program.CourseProgramProfile
Implements	`osid.OsidProfile`
Description	The course program profile describes the interoperability among course program services.
Method	supportsVisibleFederation
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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramLookup
Description	Tests if looking up programs is supported.
Return	`boolean`		`true` if program lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramQuery
Description	Tests if querying programs is supported.
Return	`boolean`		`true` if program query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSearch
Description	Tests if searching programs is supported.
Return	`boolean`		`true` if program search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramAdmin
Description	Tests if program administrative service is supported.
Return	`boolean`		`true` if program administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramNotification
Description	Tests if a program notification service is supported.
Return	`boolean`		`true` if program notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramCourseCatalog
Description	Tests if a program cataloging service is supported.
Return	`boolean`		`true` if program cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps programs to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSmartCourseCatalog
Description	Tests if a program smart course catalog session is available.
Return	`boolean`		`true` if a program smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseProgramLookup
Description	Tests if a course/program lookup service is supported.
Return	`boolean`		`true` if course/program lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseProgramAssignment
Description	Tests if a course/program mapping service is supported.
Return	`boolean`		`true` if course/program mapping service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingLookup
Description	Tests if looking up program offerings is supported.
Return	`boolean`		`true` if program offering lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingQuery
Description	Tests if querying program offerings is supported.
Return	`boolean`		`true` if program offering query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingSearch
Description	Tests if searching program offerings is supported.
Return	`boolean`		`true` if program offering search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingAdmin
Description	Tests if course offering administrative service is supported.
Return	`boolean`		`true` if program offering administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingNotification
Description	Tests if a program offering notification service is supported.
Return	`boolean`		`true` if program offering notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingCourseCatalog
Description	Tests if a program offering cataloging service is supported.
Return	`boolean`		`true` if program offering catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingCourseCatalogAssignment
Description	Tests if a program offering cataloging service is supported. A cataloging service maps program offerings to catalogs.
Return	`boolean`		`true` if program offering cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingSmartCourseCatalog
Description	Tests if a program offering smart course catalog session is available.
Return	`boolean`		`true` if a program offering smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialLookup
Description	Tests if looking up courses is supported.
Return	`boolean`		`true` if course lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialQuery
Description	Tests if querying courses is supported.
Return	`boolean`		`true` if credential query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialSearch
Description	Tests if searching courses is supported.
Return	`boolean`		`true` if credential search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialAdmin
Description	Tests if course administrative service is supported.
Return	`boolean`		`true` if course administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialNotification
Description	Tests if a course notification service is supported.
Return	`boolean`		`true` if course notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialCourseCatalog
Description	Tests if a course cataloging service is supported.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps courses to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialSmartCourseCatalog
Description	Tests if a credential smart course catalog session is available.
Return	`boolean`		`true` if a credential smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentLookup
Description	Tests if looking up enrollments is supported.
Return	`boolean`		`true` if enrollment lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentQuery
Description	Tests if querying enrollments is supported.
Return	`boolean`		`true` if enrollment query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentSearch
Description	Tests if searching enrollments is supported.
Return	`boolean`		`true` if enrollment search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentAdmin
Description	Tests if an enrollment administrative service is supported.
Return	`boolean`		`true` if enrollment administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentNotification
Description	Tests if an enrollment notification service is supported.
Return	`boolean`		`true` if enrollment notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentCourseCatalog
Description	Tests if an enrollment cataloging service is supported.
Return	`boolean`		`true` if enrollment catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentCourseCatalogAssignment
Description	Tests if an enrollment cataloging service is supported. A cataloging service maps enrollments to catalogs.
Return	`boolean`		`true` if enrollment cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentSmartCourseCatalog
Description	Tests if an enrollment smart course catalog session is available.
Return	`boolean`		`true` if an enrollment smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseProgramBatch
Description	Tests if a course program batch service is available.
Return	`boolean`		`true` if a course program batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramRecordTypes
Description	Gets the supported `program` record types.
Return	`osid.type.TypeList`		a list containing the supported `Program` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramRecordType
Description	Tests if the given `program` record type is supported.
Parameters	`osid.type.Type`	`programRecordType`	a `Type` indicating a `program` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramSearchRecordTypes
Description	Gets the supported `program` search record types.
Return	`osid.type.TypeList`		a list containing the supported `program` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSearchRecordType
Description	Tests if the given `program` search record type is supported.
Parameters	`osid.type.Type`	`programSearchRecordType`	a `Type` indicating a `Program` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingRecordTypes
Description	Gets the supported `ProgramOffering` record types.
Return	`osid.type.TypeList`		a list containing the supported `ProgramOffering` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingRecordType
Description	Tests if the given `ProgramOffering` record type is supported.
Parameters	`osid.type.Type`	`programOfferingRecordType`	a `Type` indicating an `ProgramOffering` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programOfferingRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingSearchRecordTypes
Description	Gets the supported `ProgramOffering` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ProgramOffering` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingSearchRecordType
Description	Tests if the given `ProgramOffering` search record type is supported.
Parameters	`osid.type.Type`	`programOfferingSearchRecordType`	a `Type` indicating an `ProgramOffering` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programOfferingSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialRecordTypes
Description	Gets the supported `credential` record types.
Return	`osid.type.TypeList`		a list containing the supported `credential` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialRecordType
Description	Tests if the given `credential` record type is supported.
Parameters	`osid.type.Type`	`credentialRecordType`	a `Type` indicating a `credential` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialSearchRecordTypes
Description	Gets the supported `credential` search record types.
Return	`osid.type.TypeList`		a list containing the supported `credential` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialSearchRecordType
Description	Tests if the given `credential` search record type is supported.
Parameters	`osid.type.Type`	`credentialSearchRecordType`	a `Type` indicating a `credential` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentRecordTypes
Description	Gets the supported `Enrollment` record types.
Return	`osid.type.TypeList`		a list containing the supported `Enrollment` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentRecordType
Description	Tests if the given `Enrollment` record type is supported.
Parameters	`osid.type.Type`	`enrollmentRecordType`	a `Type` indicating an `Enrollment` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`enrollmentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentSearchRecordTypes
Description	Gets the supported `Enrollment` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Enrollment` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentSearchRecordType
Description	Tests if the given `Enrollment` search record type is supported.
Parameters	`osid.type.Type`	`enrollmentSearchRecordType`	a `Type` indicating an `Enrollment` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`enrollmentSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.