OSID - osid.offering.ResultSmartCatalogueSession Service Interface Definition

Interface	osid.offering.ResultSmartCatalogueSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ResultQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of `Results` . The results may be sequenced using the `ResultSearchOrder` from this session. This `Catalogue` has a default query that matches any result and a default search order that specifies no sequencing. The queries may be examined using a `ResultQueryInspector` . The query may be modified by converting the inspector back to a `ResultQuery` .
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the `Catalogue` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartCatalogues
Description	Tests if this user can manage smart catalogues. 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 catalogue management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultQuery
Description	Gets a result query.
Return	`osid.offering.ResultQuery`		the result query
Compliance	`mandatory`		This method must be implemented.
Method	getResultSearchOrder
Description	Gets a result search order.
Return	`osid.offering.ResultSearchOrder`		the result search order
Compliance	`mandatory`		This method must be implemented.
Method	applyResultQuery
Description	Applies a result query to this catalogue.
Parameters	`osid.offering.ResultQuery`	`resultQuery`	the result query
Errors	NULL_ARGUMENT		`resultQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resultQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectResultQuery
Description	Gets a result query inspector for this catalogue.
Return	`osid.offering.ResultQueryInspector`		the result query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyResultSequencing
Description	Applies a result search order to this catalogue.
Parameters	`osid.offering.ResultSearchOrder`	`resultSearchOrder`	the result search order
Errors	NULL_ARGUMENT		`resultSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resultSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResultQueryFromInspector
Description	Gets a result query from an inspector.
Parameters	`osid.offering.ResultQueryInspector`	`resultQueryInspector`	a query inspector
Return	`osid.offering.ResultQuery`		the result query
Errors	NULL_ARGUMENT		`resultQueryInspector` is `null`
Errors	UNSUPPORTED		`resultQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.