OSID - osid.course.chronicle.ProgramEntrySmartCourseCatalogSession Service Interface Definition

Interface	osid.course.chronicle.ProgramEntrySmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProgramEntryQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `ProgramEntries`. The courses may be sequenced using the `ProgramEntrySearchOrder` from this session. This `CourseCatalog` has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a `ProgramEntryQueryInspector`. The query may be modified by converting the inspector back to a `ProgramEntryQuery`.
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	getProgramEntryQuery
Description	Gets a program entry query.
Return	`osid.course.chronicle.ProgramEntryQuery`		the program entry query
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntrySearchOrder
Description	Gets a program entry search order.
Return	`osid.course.chronicle.ProgramEntrySearchOrder`		the program entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProgramEntryQuery
Description	Applies a program entry query to this course catalog.
Parameters	`osid.course.chronicle.ProgramEntryQuery`	`programEntryQuery`	the program entry query
Errors	NULL_ARGUMENT		`programEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`programEntryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProgramEntryQuery
Description	Gets a program entry query inspector for this course catalog.
Return	`osid.course.chronicle.ProgramEntryQueryInspector`		the program entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProgramEntrySequencing
Description	Applies a program entry search order to this course catalog.
Parameters	`osid.course.chronicle.ProgramEntrySearchOrder`	`programEntrySearchOrder`	the program entry search order
Errors	NULL_ARGUMENT		`programEntrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`programEntrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryQueryFromInspector
Description	Gets a program entry query from an inspector.
Parameters	`osid.course.chronicle.ProgramEntryQueryInspector`	`programEntryQueryInspector`	a query inspector
Return	`osid.course.chronicle.ProgramEntryQuery`		the program entry query
Errors	NULL_ARGUMENT		`programEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`programEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.