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

Interface	osid.course.registration.request.RegistrationRequestSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.request.RegistrationRequestManager`
Used By	`osid.course.registration.request.RegistrationRequestProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RegistrationReques` tQuery can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `RegistrationReq` uests. The registration requests may be sequenced using the `RegistrationRequestSearc` hOrder from this session. This `CourseCatalog` has a default query that matches any registration request and a default search order that specifies no sequencing. The queries may be examined using a `RegistrationRequestQueryInsp` ector. The query may be modified by converting the inspector back to a `RegistrationRequestQuery` .
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartCourseCatalogs
Description	Tests if this user can manage smart course catalogs. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart course catalog management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestQuery
Description	Gets a registration request query.
Return	`osid.course.registration.request.RegistrationRequestQuery`		the registration request query
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestSearchOrder
Description	Gets a registration request search order.
Return	`osid.course.registration.request.RegistrationRequestSearchOrder`		the registration request search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRegistrationRequestQuery
Description	Applies a registration request query to this course catalog.
Parameters	`osid.course.registration.request.RegistrationRequestQuery`	`registrationRequestQuery`	the registration request query
Errors	NULL_ARGUMENT		`registrationRequestQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`registrationRequestQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRegistrationRequestQuery
Description	Gets a registration request query inspector for this course catalog.
Return	`osid.course.registration.request.RegistrationRequestQueryInspector`		the registration request query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRegistrationRequestSequencing
Description	Applies a registration request search order to this course catalog.
Parameters	`osid.course.registration.request.RegistrationRequestSearchOrder`	`registrationRequestSearchOrder`	the registration request search order
Errors	NULL_ARGUMENT		`registrationRequestSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`registrationRequestSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestQueryFromInspector
Description	Gets a registration request query from an inspector.
Parameters	`osid.course.registration.request.RegistrationRequestQueryInspector`	`registrationRequestQueryInspector`	a registration request query inspector
Return	`osid.course.registration.request.RegistrationRequestQuery`		the registration request query
Errors	NULL_ARGUMENT		`registrationRequestQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationRequestQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.