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

Interface	osid.resource.demographic.DemographicQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.resource.demographic.DemographicSearchSession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session provides methods for searching among `Demographics`. The search query is constructed using the `DemographicQuery`. This session defines views that offer differing behaviors for searching. federated bin view: searches include demographic in bins of which this bin is an ancestor in the bin hierarchy isolated bin view: searches are restricted to demographic in this bin Demographic may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchDemographics
Description	Tests if this user can perform `Demographic` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedBinView
Description	Federates the view for methods in this session. A federated view will include demographic in bins which are children of this broker in the bin hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBinView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.
Compliance	`mandatory`		This method is 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	getDemographicsByQuery
Description	Gets a list of `Demographics` matching the given demographic query.
Parameters	`osid.resource.demographic.DemographicQuery`	`demographicQuery`	the demographic query
Return	`osid.resource.demographic.DemographicList`		the returned `DemographicList`
Errors	NULL_ARGUMENT		`demographicQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.