OSID - osid.resource.ResourceSmartBinSession Service Interface Definition

Interface	osid.resource.ResourceSmartBinSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ResourceQuery` can be retrieved from this session and mapped to this `Bin` to create a virtual collection of `Resources.` The resources may be sequenced using the `ResourceSearchOrder` from this session. This `Bin` has a default query that matches any resource and a default search order that specifies no sequencing. The queries may be examined using a `ResourceQueryInspector.` The query may be modified by converting the inspector back to a `ResourceQuery.`
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartBins
Description	Tests if this user can manage smart bins. 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 bin management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets a resource query.
Return	`osid.resource.ResourceQuery`		the resource query
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchOrder
Description	Gets a resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Compliance	`mandatory`		This method must be implemented.
Method	applyResourceQuery
Description	Applies a resource query to this bin.
Parameters	`osid.resource.ResourceQuery`	`resourceQuery`	the resource query
Errors	NULL_ARGUMENT		`resourceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resourceQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectResourceQuery
Description	Gets a resource query inspector for this bin.
Return	`osid.resource.ResourceQueryInspector`		the resource query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyResourceSequencing
Description	Applies a resource search order to this bin.
Parameters	`osid.resource.ResourceSearchOrder`	`resourceSearchOrder`	the resource search order
Errors	NULL_ARGUMENT		`resourceSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resourceSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQueryFromInspector
Description	Gets a resource query from an inspector.
Parameters	`osid.resource.ResourceQueryInspector`	`resourceQueryInspector`	a resource query inspector
Return	`osid.resource.ResourceQuery`		the resource query
Errors	NULL_ARGUMENT		`resourceQueryInspector` is `null`
Errors	UNSUPPORTED		`resourceQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.