OSID - osid.course.requisite.CourseRequisiteProxyManager Service Interface Definition

Interface	osid.course.requisite.CourseRequisiteProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.course.requisite.CourseRequisiteProfile`
Used By	`osid.course.CourseProxyManager`
Description	The course requisite manager provides access to course requisite sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a `Proxy` for the purposes of passing information within a server application environment. The sessions included in this manager are: `RequisiteLookupSession`: a session to retrieve requisites `RequisiteQuerySession`: a session to query requisites `RequisiteSearchSession`: a session to search for requisites `RequisiteAdminSession`: a session to create and delete requisites `RequisiteNotificationSession`: a session to receive notifications pertaining to requisite changes `RequisiteCourseCatalogSession`: a session to look up requisite to course catalog mappings `RequisiteCourseCatalogAssignmentSession`: a session to manage requisite to course catalog mappings `RequisiteSmartCourseCatalogSession`: a session to manage dynamic course catalogs of requisites
Method	getRequisiteLookupSession
Description	Gets the `OsidSession` associated with the requisite lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteLookupSession`		a `RequisiteLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteLookup()` is `true`.
Method	getRequisiteLookupSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the requisite lookup service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the course catalog
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteLookupSession`		a `RequisiteLookupSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`proxy` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteLookup()` and `supportsVisibleFederation()` are `true`
Method	getRequisiteQuerySession
Description	Gets the `OsidSession` associated with the requisite query service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteQuerySession`		a `RequisiteQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteQuery()` is `true`.
Method	getRequisiteQuerySessionForCourseCatalog
Description	Gets the `OsidSession` associated with the requisite query service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteQuerySession`		a `RequisiteQuerySession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`proxy` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteQuery()` and `supportsVisibleFederation()` are `true`
Method	getRequisiteSearchSession
Description	Gets the `OsidSession` associated with the requisite search service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteSearchSession`		a `RequisiteSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteSearch()` is `true`.
Method	getRequisiteSearchSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the requisite search service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteSearchSession`		a `RequisiteSearchSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`proxy` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteSearch()` and `supportsVisibleFederation()` are `true`
Method	getRequisiteAdminSession
Description	Gets the `OsidSession` associated with the requisite administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteAdminSession`		a `RequisiteAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteAdmin()` is `true`.
Method	getRequisiteAdminSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the requisite administration service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteAdminSession`		a `RequisiteAdminSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`proxy` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteAdmin()` and `supportsVisibleFederation()` are `true`
Method	getRequisiteNotificationSession
Description	Gets the `OsidSession` associated with the requisite notification service.
Parameters	`osid.course.requisite.RequisiteReceiver`	`requisiteReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteNotificationSession`		a `RequisiteNotificationSession`
Errors	NULL_ARGUMENT		`requisiteReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteNotification()` is `true`.
Method	getRequisiteNotificationSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the requisite notification service for the given course catalog.
Parameters	`osid.course.requisite.RequisiteReceiver`	`requisiteReceiver`	the notification callback
	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteNotificationSession`		a `RequisiteNotificationSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`requisiteReceiver, courseCatalogId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteNotification()` and `supportsVisibleFederation()` are `true`
Method	getRequisiteCourseCatalogSession
Description	Gets the `OsidSession` to lookup requisite/catalog mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteCourseCatalogSession`		a `RequisiteCourseCatalogSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteCourseCatalog()` is `true`.
Method	getRequisiteCourseCatalogAssignmentSession
Description	Gets the `OsidSession` associated with assigning requisites to course catalogs.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteCourseCatalogAssignmentSession`		a `RequisiteCourseCatalogAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteCourseCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteCourseCatalogAssignment()` is `true`.
Method	getRequisiteSmartCourseCatalogSession
Description	Gets the `OsidSession` associated with the requisite smart course catalog service.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.course.requisite.RequisiteSmartCourseCatalogSession`		a `RequisiteSmartCourseCatalogSession`
Errors	NOT_FOUND		no course catalog found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRequisiteSmartCourseCatalog()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequisiteSmartCourseCatalog()` and `supportsVisibleFederation()` are `true`