OSID - osid.rules.check.AgendaSmartEngineSession Service Interface Definition

Interface	osid.rules.check.AgendaSmartEngineSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AgendaQuery` can be retrieved from this session and mapped to this `Engine` to create a virtual collection of `Agendas`. The agendas may be sequenced using the `AgendaSearchOrder` from this session. This `Engine` has a default query that matches any agenda and a default search order that specifies no sequencing. The queries may be examined using an `AgendaQueryInspector`. The query may be modified by converting the inspector back to an `AgendaQuery`.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartEngines
Description	Tests if this user can manage smart engines. 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 engine management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaQuery
Description	Gets an agenda query.
Return	`osid.rules.check.AgendaQuery`		the agenda query
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaSearchOrder
Description	Gets an agenda search order.
Return	`osid.rules.check.AgendaSearchOrder`		the agenda search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAgendaQuery
Description	Applies an agenda query to this engine.
Parameters	`osid.rules.check.AgendaQuery`	`agendaQuery`	the agenda query
Errors	NULL_ARGUMENT		`agendaQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`agendaQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAgendaQuery
Description	Gets an agenda query inspector for this engine.
Return	`osid.rules.check.AgendaQueryInspector`		the agenda query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAgendaSequencing
Description	Applies an agenda search order to this engine.
Parameters	`osid.rules.check.AgendaSearchOrder`	`agendaSearchOrder`	the agenda search order
Errors	NULL_ARGUMENT		`agendaSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`agendaSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaQueryFromInspector
Description	Gets an agenda query from an inspector.
Parameters	`osid.rules.check.AgendaQueryInspector`	`agendaQueryInspector`	an agenda query inspector
Return	`osid.rules.check.AgendaQuery`		the agenda query
Errors	NULL_ARGUMENT		`agendaQueryInspector` is `null`
Errors	UNSUPPORTED		`agendaQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.