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

Interface	osid.resource.demographic.DemographicBuilderSession
Implements	`osid.OsidSession`
Description	This session applies resource search queries and search orders to `Demographics.` Applying a search query to a demographic adds the resources resulting from that query to the demographic.
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	canBuildDemographics
Description	Tests if this user can build demographics. 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 a demographic. If a query is already applied, it is replaced with the new one.
Parameters	`osid.id.Id`	`demographicId`	a demographic `Id`
Parameters	`osid.resource.ResourceQuery`	`resourceQuery`	the resource query
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` or `resourceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resourceQuery` did not originate from `getResourceQuery()`
Compliance	`mandatory`		This method must be implemented.
Method	inspectResourceQuery
Description	Gets a resource query inspector for a demographic.
Parameters	`osid.id.Id`	`demographicId`	a demographic `Id`
Return	`osid.resource.ResourceQueryInspector`		the demographic query inspector
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceQuery
Description	Clears the resource query effectively replacing it with a wildcard query.
Parameters	`osid.id.Id`	`demographicId`	a demographic `Id`
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyResourceSequencing
Description	Applies a demographic search order to this bin.
Parameters	`osid.id.Id`	`demographicId`	a demographic `Id`
Parameters	`osid.resource.ResourceSearchOrder`	`resourceSearchOrder`	the resource search order
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` or `resourceSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`resourceSearchOrder` did not originate from `getResourceSearchOrder()`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceSequencing
Description	Clears the resource sequencing.
Parameters	`osid.id.Id`	`demographicId`	a demographic `Id`
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
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.