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

Interface	osid.course.program.ProgramOfferingSmartCourseCatalogSession
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. A `ProgramOfferingQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `ProgramOfferings`. The program offerings may be sequenced using the `ProgramOfferingSearchOrder` from this session. This `CourseCatalog` has a default query that matches any program offering and a default search order that specifies no sequencing. The queries may be examined using a `ProgramOfferingQueryInspector`. The query may be modified by converting the inspector back to a `ProgramOfferingQuery`.
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	getProgramOfferingQuery
Description	Gets a program offering query.
Return	`osid.course.program.ProgramOfferingQuery`		the program offering query
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingSearchOrder
Description	Gets a program offering search order.
Return	`osid.course.program.ProgramOfferingSearchOrder`		the program offering search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProgramOfferingQuery
Description	Applies a program offering query to this course catalog.
Parameters	`osid.course.program.ProgramOfferingQuery`	`programOfferingQuery`	the program offering query
Errors	NULL_ARGUMENT		`programOfferingQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`programOfferingQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProgramOfferingQuery
Description	Gets a program offering query inspector for this course catalog.
Return	`osid.course.program.ProgramOfferingQueryInspector`		the program offering query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProgramOfferingSequencing
Description	Applies a program offering search order to this course catalog.
Parameters	`osid.course.program.ProgramOfferingSearchOrder`	`programOfferingSearchOrder`	the program offering search order
Errors	NULL_ARGUMENT		`programOfferingSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`programOfferingSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingQueryFromInspector
Description	Gets a program offering query from an inspector.
Parameters	`osid.course.program.ProgramOfferingQueryInspector`	`programOfferingQueryInspector`	a query inspector
Return	`osid.course.program.ProgramOfferingQuery`		the program offering query
Errors	NULL_ARGUMENT		`programOfferingQueryInspector` is `null`
Errors	UNSUPPORTED		`programOfferingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.