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

Interface	osid.resource.demographic.DemographicEnablerSmartBinSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic bins. A `DemographicEnablerQuery` can be retrieved from this session and mapped to this `Bin` to create a virtual collection of demographic enablers. The demographic enablers may be sequenced using the `DemographicEnablerSearchOrder` from this session. This `Bin` has a default query that matches any demographic enabler and a default search order that specifies no sequencing. The queries may be examined using a `DemographicEnablerQueryInspector.` The query may be modified by converting the inspector back to a `DemographicEnablerQuery.`
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	getDemographicEnablerQuery
Description	Gets a demographic enabler query.
Return	`osid.resource.demographic.DemographicEnablerQuery`		the demographic enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablerSearchOrder
Description	Gets a demographic enabler search order.
Return	`osid.resource.demographic.DemographicEnablerSearchOrder`		the demographic enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDemographicEnablerQuery
Description	Applies a demographic enabler query to this bin.
Parameters	`osid.resource.demographic.DemographicEnablerQuery`	`demographicEnablerQuery`	the demographic enabler query
Errors	NULL_ARGUMENT		`demographicEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`demographicEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDemographicEnablerQuery
Description	Gets a demographic enabler query inspector for this bin.
Return	`osid.resource.demographic.DemographicEnablerQueryInspector`		the demographic enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDemographicEnablerSequencing
Description	Applies a demographic enabler search order to this bin.
Parameters	`osid.resource.demographic.DemographicEnablerSearchOrder`	`demographicEnablerSearchOrder`	the demographic enabler search order
Errors	NULL_ARGUMENT		`demographicEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`demographicEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablerQueryFromInspector
Description	Gets a demographic enabler query from an inspector.
Parameters	`osid.resource.demographic.DemographicEnablerQueryInspector`	`demographicEnablerQueryInspector`	a demographic enabler query inspector
Return	`osid.resource.demographic.DemographicEnablerQuery`		the demographic enabler query
Errors	NULL_ARGUMENT		`demographicEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`demographicEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.