OSID - osid.course.CourseProfile Service Interface Definition

Interface	osid.course.CourseProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.course.CourseManager`
Implemented By	`osid.course.CourseProxyManager`
Description	The course profile describes the interoperability among course management 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	supportsCourseLookup
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	supportsCourseQuery
Description	Tests if querying courses is supported.
Return	`boolean`		`true` if course query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseSearch
Description	Tests if searching courses is supported.
Return	`boolean`		`true` if course search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseAdmin
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	supportsCourseNotification
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	supportsCourseCourseCatalog
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	supportsCourseCourseCatalogAssignment
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	supportsCourseSmartCourseCatalog
Description	Tests if a course smart course catalog session is available.
Return	`boolean`		`true` if a course smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitLookup
Description	Tests if looking up activity units is supported.
Return	`boolean`		`true` if activity unit lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitQuery
Description	Tests if querying activity units is supported.
Return	`boolean`		`true` if activity unit query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitSearch
Description	Tests if searching activity units is supported.
Return	`boolean`		`true` if activity unit search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitAdmin
Description	Tests if an activity unit administrative service is supported.
Return	`boolean`		`true` if activity unit administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitNotification
Description	Tests if an activity unit notification service is supported.
Return	`boolean`		`true` if activity unit notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitCourseCatalog
Description	Tests if an activity unit cataloging service is supported.
Return	`boolean`		`true` if activity unit catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitCourseCatalogAssignment
Description	Tests if an activity unit cataloging service is supported. A cataloging service maps activity units to catalogs.
Return	`boolean`		`true` if activity unit cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitSmartCourseCatalog
Description	Tests if an activity unit smart course catalog session is available.
Return	`boolean`		`true` if an activity unit smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingLookup
Description	Tests if looking up course offerings is supported.
Return	`boolean`		`true` if course offering lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingQuery
Description	Tests if querying course offerings is supported.
Return	`boolean`		`true` if course offering query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingSearch
Description	Tests if searching course offerings is supported.
Return	`boolean`		`true` if course offering search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingAdmin
Description	Tests if course offering administrative service is supported.
Return	`boolean`		`true` if course offering administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingNotification
Description	Tests if a course offering notification service is supported.
Return	`boolean`		`true` if course offering notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingCourseCatalog
Description	Tests if a course offering cataloging service is supported.
Return	`boolean`		`true` if course offering catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingCourseCatalogAssignment
Description	Tests if a course offering cataloging service is supported. A cataloging service maps course offerings to catalogs.
Return	`boolean`		`true` if course offering cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingSmartCourseCatalog
Description	Tests if a course offering smart course catalog session is available.
Return	`boolean`		`true` if a course offering smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityLookup
Description	Tests if looking up activities is supported.
Return	`boolean`		`true` if activity lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if querying activities is supported.
Return	`boolean`		`true` if activity query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySearch
Description	Tests if searching activities is supported.
Return	`boolean`		`true` if activity search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityAdmin
Description	Tests if activity administrative service is supported.
Return	`boolean`		`true` if activity administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityNotification
Description	Tests if an activity notification service is supported.
Return	`boolean`		`true` if activity notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityCourseCatalog
Description	Tests if an activity cataloging service is supported.
Return	`boolean`		`true` if activity catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityCourseCatalogAssignment
Description	Tests if an activity cataloging service is supported. A cataloging service maps activities to catalogs.
Return	`boolean`		`true` if activity cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySmartCourseCatalog
Description	Tests if an activity smart course catalog session is available.
Return	`boolean`		`true` if an activity smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnravelling
Description	Tests if unravelling activities is supported.
Return	`boolean`		`true` if unravelling activities is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermLookup
Description	Tests if looking up terms is supported.
Return	`boolean`		`true` if term lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermQuery
Description	Tests if querying terms is supported.
Return	`boolean`		`true` if term query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermSearch
Description	Tests if searching terms is supported.
Return	`boolean`		`true` if term search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermAdmin
Description	Tests if term administrative service is supported.
Return	`boolean`		`true` if term administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermNotification
Description	Tests if a term notification service is supported.
Return	`boolean`		`true` if term notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermHierarchy
Description	Tests if term hierarchy traversal service is supported.
Return	`boolean`		`true` if term hierarchy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermHierarchyDesign
Description	Tests if a term hierarchy design service is supported.
Return	`boolean`		`true` if term hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermCourseCatalog
Description	Tests if a term cataloging service is supported.
Return	`boolean`		`true` if term catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermCourseCatalogAssignment
Description	Tests if a term cataloging service is supported. A cataloging service maps terms to catalogs.
Return	`boolean`		`true` if term cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermSmartCourseCatalog
Description	Tests if a term smart course catalog session is available.
Return	`boolean`		`true` if a term smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogLookup
Description	Tests if looking up course catalogs is supported.
Return	`boolean`		`true` if course catalog lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogSearch
Description	Tests if searching course catalogs is supported.
Return	`boolean`		`true` if course catalog search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if querying course catalogs is supported.
Return	`boolean`		`true` if course catalog query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogAdmin
Description	Tests if course catalog administrative service is supported.
Return	`boolean`		`true` if course catalog administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogNotification
Description	Tests if a course catalog notification service is supported.
Return	`boolean`		`true` if course catalog notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogHierarchy
Description	Tests for the availability of a course catalog hierarchy traversal service.
Return	`boolean`		`true` if course catalog hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsCourseCatalogHierarchyDesign
Description	Tests for the availability of a course catalog hierarchy design service.
Return	`boolean`		`true` if course catalog hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseBatch
Description	Tests for the availability of a course batch service.
Return	`boolean`		`true` if a course batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseProgram
Description	Tests for the availability of a course program service.
Return	`boolean`		`true` if a course program service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistration
Description	Tests for the availability of a course registration service.
Return	`boolean`		`true` if a course registration service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRequisite
Description	Tests for the availability of a course requisite service.
Return	`boolean`		`true` if a course requisite service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseSyllabus
Description	Tests for the availability of a course syllabus service.
Return	`boolean`		`true` if a course syllabus service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoursePlan
Description	Tests for the availability of a course plan service.
Return	`boolean`		`true` if a course plan service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseChronicle
Description	Tests for the availability of a course chronicle service.
Return	`boolean`		`true` if a course chronicle service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRecordTypes
Description	Gets the supported `Course` record types.
Return	`osid.type.TypeList`		a list containing the supported `Course` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRecordType
Description	Tests if the given `Course` record type is supported.
Parameters	`osid.type.Type`	`courseRecordType`	a `Type` indicating a `Course` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseSearchRecordTypes
Description	Gets the supported `Course` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Course` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseSearchRecordType
Description	Tests if the given `Course` search record type is supported.
Parameters	`osid.type.Type`	`courseSearchRecordType`	a `Type` indicating a `Course` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitRecordTypes
Description	Gets the supported `ActivityUnit` record types.
Return	`osid.type.TypeList`		a list containing the supported `ActivityUnit` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitRecordType
Description	Tests if the given `ActivityUnit` record type is supported.
Parameters	`osid.type.Type`	`activityUnitRecordType`	a `Type` indicating an `ActivityUnit` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityUnitRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitSearchRecordTypes
Description	Gets the supported `ActivityUnit` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ActivityUnit` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitSearchRecordType
Description	Tests if the given `ActivityUnit` search record type is supported.
Parameters	`osid.type.Type`	`activityUnitSearchRecordType`	a `Type` indicating an `ActivityUnit` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityUnitSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingRecordTypes
Description	Gets the supported `CourseOffering` record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseOffering` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingRecordType
Description	Tests if the given `CourseOffering` record type is supported.
Parameters	`osid.type.Type`	`courseOfferingRecordType`	a `Type` indicating an `CourseOffering` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseOfferingRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingSearchRecordTypes
Description	Gets the supported `CourseOffering` search record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseOffering` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingSearchRecordType
Description	Tests if the given `CourseOffering` search record type is supported.
Parameters	`osid.type.Type`	`courseOfferingSearchRecordType`	a `Type` indicating an `CourseOffering` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseOfferingSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRecordTypes
Description	Gets the supported `Activity` record types.
Return	`osid.type.TypeList`		a list containing the supported `Activity` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRecordType
Description	Tests if the given `Activity` record type is supported.
Parameters	`osid.type.Type`	`activityRecordType`	a `Type` indicating an `Activity` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivitySearchRecordTypes
Description	Gets the supported `Activity` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Activity` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySearchRecordType
Description	Tests if the given `Activity` search record type is supported.
Parameters	`osid.type.Type`	`activitySearchRecordType`	a `Type` indicating an `Activity` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activitySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTermRecordTypes
Description	Gets the supported `Term` record types.
Return	`osid.type.TypeList`		a list containing the supported `Term` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermRecordType
Description	Tests if the given `Term` record type is supported.
Parameters	`osid.type.Type`	`termRecordType`	a `Type` indicating a `Term` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`termRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTermSearchRecordTypes
Description	Gets the supported `Term` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Term` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermSearchRecordType
Description	Tests if the given `Term` search record type is supported.
Parameters	`osid.type.Type`	`termSearchRecordType`	a `Type` indicating a `Term` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`termSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogRecordTypes
Description	Gets the supported `CourseCatalog` record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseCatalog` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogRecordType
Description	Tests if the given `CourseCatalog` record type is supported.
Parameters	`osid.type.Type`	`courseCatalogRecordType`	a `Type` indicating an `CourseCatalog` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseCatalogRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogSearchRecordTypes
Description	Gets the supported `CourseCatalog` search record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseCatalog` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogSearchRecordType
Description	Tests if the given `CourseCatalog` search record type is supported.
Parameters	`osid.type.Type`	`courseCatalogSearchRecordType`	a `Type` indicating an `CourseCatalog` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseCatalogSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.