OSID - osid.course.registration.CourseRegistrationProfile Service Interface Definition

Interface	osid.course.registration.CourseRegistrationProfile
Implements	`osid.OsidProfile`
Description	The course registration profile describes the interoperability among course registration 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	supportsActivityBundleLookup
Description	Tests if looking up activity bundles is supported.
Return	`boolean`		`true` if activity bundle lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleQuery
Description	Tests if querying activity bundles is supported.
Return	`boolean`		`true` if activity bundle query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleSearch
Description	Tests if searching activity bundles is supported.
Return	`boolean`		`true` if activity bundle search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleAdmin
Description	Tests if an activity bundle administrative service is supported.
Return	`boolean`		`true` if activity bundle administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleNotification
Description	Tests if an activity bundle notification service is supported.
Return	`boolean`		`true` if activity bundle notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleCourseCatalog
Description	Tests if an activity bundle cataloging service is supported.
Return	`boolean`		`true` if activity bundle catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleCourseCatalogAssignment
Description	Tests if an activity bundle cataloging service is supported. A cataloging service maps activity bundles to catalogs.
Return	`boolean`		`true` if activity bundle cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleSmartCourseCatalog
Description	Tests if an activity bundle smart course catalog session is available.
Return	`boolean`		`true` if an activity bundle smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationLookup
Description	Tests if looking up registrations is supported.
Return	`boolean`		`true` if registration lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationQuery
Description	Tests if querying registrations is supported.
Return	`boolean`		`true` if registration query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationSearch
Description	Tests if searching registrations is supported.
Return	`boolean`		`true` if registration search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationAdmin
Description	Tests if course offering administrative service is supported.
Return	`boolean`		`true` if registration administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationNotification
Description	Tests if a registration notification service is supported.
Return	`boolean`		`true` if registration notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationCourseCatalog
Description	Tests if a registration cataloging service is supported.
Return	`boolean`		`true` if registration catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationCourseCatalogAssignment
Description	Tests if a registration cataloging service is supported. A cataloging service maps registrations to catalogs.
Return	`boolean`		`true` if registration cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationSmartCourseCatalog
Description	Tests if a registration smart course catalog session is available.
Return	`boolean`		`true` if a registration smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationLookup
Description	Tests if looking up activity registrations is supported.
Return	`boolean`		`true` if activity registration lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationQuery
Description	Tests if querying activity registrations is supported.
Return	`boolean`		`true` if activity registration query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationSearch
Description	Tests if searching activity registrations is supported.
Return	`boolean`		`true` if activity registration search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationAdmin
Description	Tests if an activity registration administrative service is supported.
Return	`boolean`		`true` if activity registration administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationNotification
Description	Tests if an activity registration notification service is supported.
Return	`boolean`		`true` if activity registration notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationCourseCatalog
Description	Tests if an activity registration cataloging service is supported.
Return	`boolean`		`true` if activity registration catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationCourseCatalogAssignment
Description	Tests if an activity registration cataloging service is supported. A cataloging service maps activity registrations to catalogs.
Return	`boolean`		`true` if activity registration cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationSmartCourseCatalog
Description	Tests if an activity registration smart course catalog session is available.
Return	`boolean`		`true` if an activity registration smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationBatch
Description	Tests if a course registration batch service is available.
Return	`boolean`		`true` if a course registration service session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundleRecordTypes
Description	Gets the supported `ActivityBundle` record types.
Return	`osid.type.TypeList`		a list containing the supported `ActivityBundle` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleRecordType
Description	Tests if the given `ActivityBundle` record type is supported.
Parameters	`osid.type.Type`	`activityBundleRecordType`	a `Type` indicating an `ActivityBundle` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityBundleRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundleSearchRecordTypes
Description	Gets the supported `ActivityBundle` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ActivityBundle` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBundleSearchRecordType
Description	Tests if the given `ActivityBundle` search record type is supported.
Parameters	`osid.type.Type`	`activityBundleSearchRecordType`	a `Type` indicating an `ActivityBundle` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityBundleSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRecordTypes
Description	Gets the supported `Registration` record types.
Return	`osid.type.TypeList`		a list containing the supported `Registration` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationRecordType
Description	Tests if the given `Registration` record type is supported.
Parameters	`osid.type.Type`	`registrationRecordType`	a `Type` indicating an `Registration` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationSearchRecordTypes
Description	Gets the supported `Registration` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Registration` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationSearchRecordType
Description	Tests if the given `Registration` search record type is supported.
Parameters	`osid.type.Type`	`registrationSearchRecordType`	a `Type` indicating an `Registration` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationRecordTypes
Description	Gets the supported `ActivityRegistration` record types.
Return	`osid.type.TypeList`		a list containing the supported `ActivityRegistration` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationRecordType
Description	Tests if the given `ActivityRegistration` record type is supported.
Parameters	`osid.type.Type`	`activityRegistrationRecordType`	a `Type` indicating an `ActivityRegistration` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRegistrationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationSearchRecordTypes
Description	Gets the supported `ActivityRegistration` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ActivityRegistration` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRegistrationSearchRecordType
Description	Tests if the given `ActivityRegistration` search record type is supported.
Parameters	`osid.type.Type`	`activityRegistrationSearchRecordType`	a `Type` indicating an `ActivityRegistration` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRegistrationSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.