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

Interface	osid.course.registration.CourseRegistrationProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.course.registration.CourseRegistrationManager`
Implemented By	`osid.course.registration.CourseRegistrationProxyManager`
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	supportsRegistrationTargetLookup
Description	Tests if looking up registration targets is supported.
Return	`boolean`		`true` if registration target lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetQuery
Description	Tests if querying registration targets is supported.
Return	`boolean`		`true` if registration target query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetSearch
Description	Tests if searching registration targets is supported.
Return	`boolean`		`true` if registration target search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetAdmin
Description	Tests if a registration target administrative service is supported.
Return	`boolean`		`true` if registration target administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetNotification
Description	Tests if a registration target notification service is supported.
Return	`boolean`		`true` if registration target notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetCourseCatalog
Description	Tests if a registration target course catalog lookup service is supported.
Return	`boolean`		`true` if a registration target course catalog lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetCourseCatalogAssignment
Description	Tests if a registration target course catalog assignment service is supported.
Return	`boolean`		`true` if a registration target to course catalog assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetSmartCourseCatalog
Description	Tests if a registration target smart course catalog service is supported.
Return	`boolean`		`true` if a smart course catalog service 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	supportsCourseRegistrationLookup
Description	Tests if looking up course registrations is supported.
Return	`boolean`		`true` if course registration lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationQuery
Description	Tests if querying course registrations is supported.
Return	`boolean`		`true` if course registration query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationSearch
Description	Tests if searching course registrations is supported.
Return	`boolean`		`true` if course registration search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationAdmin
Description	Tests if a course registration administrative service is supported.
Return	`boolean`		`true` if course registration administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationNotification
Description	Tests if a course registration notification service is supported.
Return	`boolean`		`true` if course registration notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationCourseCatalog
Description	Tests if a course registration course catalog lookup service is supported.
Return	`boolean`		`true` if a course registration course catalog lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationCourseCatalogAssignment
Description	Tests if a course registration course catalog assignment service is supported.
Return	`boolean`		`true` if a course registration to course catalog assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationSmartCourseCatalog
Description	Tests if a course registration smart course catalog service is supported.
Return	`boolean`		`true` if a smart course catalog service 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 batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationRequest
Description	Tests if a course registration request service is available.
Return	`boolean`		`true` if a course registration request service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetRecordTypes
Description	Gets the supported `RegistrationTarget` record types.
Return	`osid.type.TypeList`		a list containing the supported `RegistrationTarget` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetRecordType
Description	Tests if the given `RegistrationTarget` record type is supported.
Parameters	`osid.type.Type`	`registrationTargetRecordType`	a `Type` indicating a `RegistrationTarget` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationTargetRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetSearchRecordTypes
Description	Gets the supported `RegistrationTarget` search types.
Return	`osid.type.TypeList`		a list containing the supported `RegistrationTarget` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetSearchRecordType
Description	Tests if the given `RegistrationTarget` search type is supported.
Parameters	`osid.type.Type`	`registrationTargetSearchRecordType`	a `Type` indicating a `RegistrationTarget` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationTargetSearchRecordType` 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	getCourseRegistrationRecordTypes
Description	Gets the supported `CourseRegistration` record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseRegistration` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationRecordType
Description	Tests if the given `CourseRegistration` record type is supported.
Parameters	`osid.type.Type`	`courseRegistrationRecordType`	a `Type` indicating a `CourseRegistration` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseRegistrationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationSearchRecordTypes
Description	Gets the supported `CourseRegistration` search types.
Return	`osid.type.TypeList`		a list containing the supported `CourseRegistration` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationSearchRecordType
Description	Tests if the given `CourseRegistration` search type is supported.
Parameters	`osid.type.Type`	`courseRegistrationSearchRecordType`	a `Type` indicating a `CourseRegistration` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseRegistrationSearchRecordType` is `null`
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.