OSID - osid.course.program.EnrollmentSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.program.EnrollmentSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.program.CourseProgramManager`
Used By	`osid.course.program.CourseProgramProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `EnrollmentQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `Enrollments`. The enrollments may be sequenced using the `EnrollmentSearchOrder` from this session. This `CourseCatalog` has a default query that matches any enrollment and a default search order that specifies no sequencing. The queries may be examined using an `EnrollmentQueryInspector`. The query may be modified by converting the inspector back to an `EnrollmentQuery`.
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 assessment. 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	getEnrollmentQuery
Description	Gets an enrollment query.
Return	`osid.course.program.EnrollmentQuery`		the enrollment query
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentSearchOrder
Description	Gets an enrollment search order.
Return	`osid.course.program.EnrollmentSearchOrder`		the enrollment search order
Compliance	`mandatory`		This method must be implemented.
Method	applyEnrollmentQuery
Description	Applies an enrollment query to this course catalog.
Parameters	`osid.course.program.EnrollmentQuery`	`enrollmentQuery`	the enrollment query
Errors	NULL_ARGUMENT		`enrollmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`enrollmentQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectEnrollmentQuery
Description	Gets an enrollment query inspector for this course catalog.
Return	`osid.course.program.EnrollmentQueryInspector`		the enrollment query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyEnrollmentSequencing
Description	Applies an enrollment search order to this course catalog.
Parameters	`osid.course.program.EnrollmentSearchOrder`	`enrollmentSearchOrder`	the enrollment search order
Errors	NULL_ARGUMENT		`enrollmentSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`enrollmentSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentQueryFromInspector
Description	Gets an enrollment query from an inspector.
Parameters	`osid.course.program.EnrollmentQueryInspector`	`enrollmentQueryInspector`	a query inspector
Return	`osid.course.program.EnrollmentQuery`		the enrollment query
Errors	NULL_ARGUMENT		`enrollmentQueryInspector` is `null`
Errors	UNSUPPORTED		`enrollmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.