OSID - osid.course.registration.request.RegistrationRequestManager Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestManager
Implements	`osid.OsidManager`
Implements	`osid.course.registration.request.RegistrationRequestProfile`
Used By	`osid.course.registration.CourseRegistrationManager`
Description	The course registration.request manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `RegistrationRequestLookupSe` ssion: a session to retrieve registration requests `RegistrationRequestQuerySe` ssion: a session to query for registration requests `RegistrationRequestSearchSe` ssion: a session to search for registration requests `RegistrationRequestAdminSe` ssion: a session to create and delete registration requests `RegistrationRequestNotificationSe` ssion: a session to receive notifications pertaining to registration request changes `RegistrationRequestCourseCatalogSe` ssion: a session to look up registration request course catalog mappings `RegistrationRequestCourseCatalogAssignmentSe` ssion: a session to manage registration request to course catalog mappings `RegistrationRequestSmartCourseCatalogSession`: a session to manage dynamic course catalogs of registration requests `RegistrationRequestItemLook` upSession: a session to retrieve registration request items `RegistrationRequestItemQue` rySession: a session to query for registration request items `RegistrationRequestItemSear` chSession: a session to search for registration request items `RegistrationRequestItemAdm` inSession: a session to create and delete registration request items `RegistrationRequestItemNotificati` onSession: a session to receive notifications pertaining to registration request item changes `RegistrationRequestItemCourseCatal` ogSession: a session to look up registration request item course catalog mappings `RegistrationRequestItemCourseCatalogAssignme` ntSession: a session to manage registration request item to course catalog mappings `RegistrationRequestItemSmartCourseCatalogSes` sion: a session to manage dynamic course catalogs of registration request items
Method	getRegistrationRequestLookupSession
Description	Gets the `OsidSession` associated with the registration request lookup service.
Return	`osid.course.registration.request.RegistrationRequestLookupSession`		a `RegistrationRequestLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestLookup()` is `true`.
Method	getRegistrationRequestLookupSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request lookup service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestLookupSession`		a `RegistrationRequestLookupSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestLookup()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestQuerySession
Description	Gets the `OsidSession` associated with the registration request query service.
Return	`osid.course.registration.request.RegistrationRequestQuerySession`		a `RegistrationRequestQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestQuery()` is `true`.
Method	getRegistrationRequestQuerySessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request query service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestQuerySession`		a `RegistrationRequestQuerySession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestQuery()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestSearchSession
Description	Gets the `OsidSession` associated with the registration request search service.
Return	`osid.course.registration.request.RegistrationRequestSearchSession`		a `RegistrationRequestSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestSearch()` is `true`.
Method	getRegistrationRequestSearchSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request search service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestSearchSession`		a `RegistrationRequestSearchSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestSearch()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestAdminSession
Description	Gets the `OsidSession` associated with the registration request administration service.
Return	`osid.course.registration.request.RegistrationRequestAdminSession`		a `RegistrationRequestAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestAdmin()` is `true`.
Method	getRegistrationRequestAdminSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request administration service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestAdminSession`		a `RegistrationRequestAdminSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestAdmin()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestNotificationSession
Description	Gets the `OsidSession` associated with the registration request notification service.
Parameters	`osid.course.registration.request.RegistrationRequestReceiver`	`registrationRequestReceiver`	the notification callback
Return	`osid.course.registration.request.RegistrationRequestNotificationSession`		a `RegistrationRequestNotificationSession`
Errors	NULL_ARGUMENT		`registrationRequestReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestNotification()` is `true`.
Method	getRegistrationRequestNotificationSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request notification service for the given course catalog.
Parameters	`osid.course.registration.request.RegistrationRequestReceiver`	`registrationRequestReceiver`	the notification callback
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestNotificationSession`		a `RegistrationRequestNotificationSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`registrationRequestReceiver` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestNotification()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestCourseCatalogSession
Description	Gets the `OsidSession` to lookup registration request/course catalog mappings.
Return	`osid.course.registration.request.RegistrationRequestCourseCatalogSession`		a `RegistrationRequestCourseCatalogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestCourseCatalog()` is `true`.
Method	getRegistrationRequestCourseCatalogAssignmentSession
Description	Gets the `OsidSession` associated with assigning registration requests to course catalogs.
Return	`osid.course.registration.request.RegistrationRequestCourseCatalogAssignmentSession`		a `RegistrationRequestCourseCatalogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestCourseCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestCourseCatalogAssignment()` is `true`.
Method	getRegistrationRequestSmartCourseCatalogSession
Description	Gets the `OsidSession` to manage registration request smart course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestSmartCourseCatalogSession`		a `RegistrationRequestSmartCourseCatalogSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestSmartCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestSmartCourseCatalog()` is `true`.
Method	getRegistrationRequestItemLookupSession
Description	Gets the `OsidSession` associated with the registration request item lookup service.
Return	`osid.course.registration.request.RegistrationRequestItemLookupSession`		a `RegistrationRequestItemLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestItemLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemLookup()` is `true`.
Method	getRegistrationRequestItemLookupSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request item lookup service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestItemLookupSession`		a `RegistrationRequestItemLookupSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemLookup()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestItemQuerySession
Description	Gets the `OsidSession` associated with the registration request item query service.
Return	`osid.course.registration.request.RegistrationRequestItemQuerySession`		a `RegistrationRequestItemQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemQuery()` is `true`.
Method	getRegistrationRequestItemQuerySessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request item query service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestItemQuerySession`		a `RegistrationRequestItemQuerySession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemQuery()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestItemSearchSession
Description	Gets the `OsidSession` associated with the registration request item search service.
Return	`osid.course.registration.request.RegistrationRequestItemSearchSession`		a `RegistrationRequestItemSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestItemSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemSearch()` is `true`.
Method	getRegistrationRequestItemSearchSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request item search service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestItemSearchSession`		a `RegistrationRequestItemSearchSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogI` d is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemSearch()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestItemAdminSession
Description	Gets the `OsidSession` associated with the registration request item administration service.
Return	`osid.course.registration.request.RegistrationRequestItemAdminSession`		a `RegistrationRequestItemAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestItemAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemAdmin()` is `true`.
Method	getRegistrationRequestItemAdminSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request item administration service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestItemAdminSession`		a `RegistrationRequestItemAdminSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogI` d is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemAdmin()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestItemNotificationSession
Description	Gets the `OsidSession` associated with the registration request item notification service.
Parameters	`osid.course.registration.request.RegistrationRequestItemReceiver`	`registrationRequestItemReceiver`	the notification callback
Return	`osid.course.registration.request.RegistrationRequestItemNotificationSession`		a `RegistrationRequestItemNotificationSession`
Errors	NULL_ARGUMENT		`registrationRequestItemReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemNotification()` is `true`.
Method	getRegistrationRequestItemNotificationSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the registration request item notification service for the given course catalog.
Parameters	`osid.course.registration.request.RegistrationRequestItemReceiver`	`registrationRequestItemReceiver`	the notification callback
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestItemNotificationSession`		a `RegistrationRequestItemNotificationSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`registrationRequestItemReceiver` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemNotification()` and `supportsVisibleFederation()` are `true`.
Method	getRegistrationRequestItemCourseCatalogSession
Description	Gets the `OsidSession` to lookup registration request item/course catalog mappings.
Return	`osid.course.registration.request.RegistrationRequestItemCourseCatalogSession`		a `RegistrationRequestItemCourseCatalogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestItemCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemCourseCatalog()` is `true`.
Method	getRegistrationRequestItemCourseCatalogAssignmentSession
Description	Gets the `OsidSession` associated with assigning registration request items to course catalogs.
Return	`osid.course.registration.request.RegistrationRequestItemCourseCatalogAssignmentSession`		a `RegistrationRequestItemCourseCatalogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRegistrationRequestItemCourseCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemCourseCatalogAssignment()` is `true`.
Method	getRegistrationRequestItemSmartCourseCatalogSession
Description	Gets the `OsidSession` to manage registration request item smart course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.registration.request.RegistrationRequestItemSmartCourseCatalogSession`		a `RegistrationRequestItemSmartCourseCatalogSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRegistrationRequestItemSmartCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestItemSmartCourseCatalog()` is `true`.