OSID - osid.resource.ResourceRelationshipSmartBinSession Service Interface Definition

Interface	osid.resource.ResourceRelationshipSmartBinSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ResourceRelationshipQuery` can be retrieved from this session and mapped to this `Bin` to create a virtual collection of `ResourceRelationships.` The resource relationships may be sequenced using the `ResourceRelationshipSearchOrder` 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 `ResourceRelationshipQueryInspector.` The query may be modified by converting the inspector back to a `ResourceRelationshipQuery.`
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	getResourceRelationshipQuery
Description	Gets a resource relationship query.
Return	`osid.resource.ResourceRelationshipQuery`		the resource relationship query
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipSearchOrder
Description	Gets a resource relationship search order.
Return	`osid.resource.ResourceRelationshipSearchOrder`		the resource relationship search order
Compliance	`mandatory`		This method must be implemented.
Method	applyResourceRelationshipQuery
Description	Applies a resource relationship query to this bin.
Parameters	`osid.resource.ResourceRelationshipQuery`	`resourceQuery`	the resource relationship query
Errors	NULL_ARGUMENT		`resourceRelationshipQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resourceRelationshipQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectResourceRelationshipQuery
Description	Gets a resource relationship query inspector for this bin.
Return	`osid.resource.ResourceRelationshipQueryInspector`		the resource relationship query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyResourceRelationshipSequencing
Description	Applies a resource relationship search order to this bin.
Parameters	`osid.resource.ResourceRelationshipSearchOrder`	`resourceRelationshipSearchOrder`	the resource relationship search order
Errors	NULL_ARGUMENT		`resourceRelationshipSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resourceRelationshipSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipQueryFromInspector
Description	Gets a resource relationship query from an inspector.
Parameters	`osid.resource.ResourceRelationshipQueryInspector`	`resourceRelationshipQueryInspector`	a resource relationship query inspector
Return	`osid.resource.ResourceQuery`		the resource relationship query
Errors	NULL_ARGUMENT		`resourceRelationshipQueryInspector` is `null`
Errors	UNSUPPORTED		`resourceRelationshipQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.