OSID - osid.resourcing.AvailabilityQuerySession Service Interface Definition

Interface	osid.resourcing.AvailabilityQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.resourcing.AvailabilitySearchSession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session provides methods for searching among `Availability` objects. The search query is constructed using the `AvailabilityQuery`. This session defines views that offer differing behaviors for searching. federated foundry view: searches include availabilities in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to availabilities in this foundry Availabilities may have a query record indicated by their respective record types. The query record is accessed via the `AvailabilityQuery`.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAvailabilities
Description	Tests if this user can perform `Availability` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAvailabilityQuery
Description	Gets an availability query.
Return	`osid.resourcing.AvailabilityQuery`		the availability query
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesByQuery
Description	Gets a list of `Availabilities` matching the given availability query.
Parameters	`osid.resourcing.AvailabilityQuery`	`availabilityQuery`	the availability query
Return	`osid.resourcing.AvailabilityList`		the returned `AvailabilityList`
Errors	NULL_ARGUMENT		`availabilityQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.