OSID - osid.offering.ParticipantSmartCatalogueSession Service Interface Definition

Interface	osid.offering.ParticipantSmartCatalogueSession
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 `ParticipantQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of `Participants`. The participants may be sequenced using the `ParticipantSearchOrder` from this session. This `Catalogue` has a default query that matches any participant and a default search order that specifies no sequencing. The queries may be examined using a `ParticipantQueryInspector`. The query may be modified by converting the inspector back to a `ParticipantQuery`.
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	getParticipantQuery
Description	Gets a participant query.
Return	`osid.offering.ParticipantQuery`		the participant query
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantSearchOrder
Description	Gets a participant search order.
Return	`osid.offering.ParticipantSearchOrder`		the participant search order
Compliance	`mandatory`		This method must be implemented.
Method	applyParticipantQuery
Description	Applies a participant query to this catalogue.
Parameters	`osid.offering.ParticipantQuery`	`participantQuery`	the participant query
Errors	NULL_ARGUMENT		`participantQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`participantQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectParticipantQuery
Description	Gets a participant query inspector for this catalogue.
Return	`osid.offering.ParticipantQueryInspector`		the participant query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyParticipantSequencing
Description	Applies a participant search order to this catalogue.
Parameters	`osid.offering.ParticipantSearchOrder`	`participantSearchOrder`	the participant search order
Errors	NULL_ARGUMENT		`participantSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`participantSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantQueryFromInspector
Description	Gets a participant query from an inspector.
Parameters	`osid.offering.ParticipantQueryInspector`	`participantQueryInspector`	a query inspector
Return	`osid.offering.ParticipantQuery`		the participant query
Errors	NULL_ARGUMENT		`participantQueryInspector` is `null`
Errors	UNSUPPORTED		`participantQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.