OSID - osid.resource.demographic.DemographicSmartBinSession Service Interface Definition

Interface	osid.resource.demographic.DemographicSmartBinSession
Implements	`osid.OsidSession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic bins. A `DemographicQuery` can be retrieved from this session and mapped to this `Bin` to create a virtual collection of demographics. The demographic may be sequenced using the `DemographicSearchOrder` from this session. This `Bin` has a default query that matches any demographic and a default search order that specifies no sequencing. The queries may be examined using a `DemographicQueryInspector`. The query may be modified by converting the inspector back to a `DemographicQuery`.
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
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	getDemographicQuery
Description	Gets a demographic query.
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicSearchOrder
Description	Gets a demographic search order.
Return	`osid.resource.demographic.DemographicSearchOrder`		the demographic search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDemographicQuery
Description	Applies a demographic query to this bin.
Parameters	`osid.resource.demographic.DemographicQuery`	`demographicQuery`	the demographic query
Errors	NULL_ARGUMENT		`demographicQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`demographicQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDemographicQuery
Description	Gets a demographic query inspector for this bin.
Return	`osid.resource.demographic.DemographicQueryInspector`		the demographic query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDemographicSequencing
Description	Applies a demographic search order to this bin.
Parameters	`osid.resource.demographic.DemographicSearchOrder`	`demographicSearchOrder`	the demographic search order
Errors	NULL_ARGUMENT		`demographicSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`demographicSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicQueryFromInspector
Description	Gets a demographic query from an inspector.
Parameters	`osid.resource.demographic.DemographicQueryInspector`	`demographicQueryInspector`	a demographic query inspector
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	NULL_ARGUMENT		`demographicQueryInspector` is `null`
Errors	UNSUPPORTED		`demographicQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.