OSID - osid.resourcing.rules.AvailabilityEnablerQuerySession Service Interface Definition

Interface	osid.resourcing.rules.AvailabilityEnablerQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `AvailabilityEnabler` objects. The search query is constructed using the `AvailabilityEnablerQuery.` This session defines views that offer differing behaviors for searching. federated foundry view: searches include availability enablers in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to availability enablers in this foundry An availability enabler may have an availability enabler query record indicated by their respective record types. The availability enabler query record is accessed via the `AvailabilityEnablerQuery.`
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	canSearchAvailabilityEnablers
Description	Tests if this user can perform `AvailabilityEnabler` 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 availability enabler in foundries which are children of this availability 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	getAvailabilityEnablerQuery
Description	Gets an availability enabler query.
Return	`osid.resourcing.rules.AvailabilityEnablerQuery`		the availability enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersByQuery
Description	Gets a list of `AvailabilityEnablers` matching the given availability enabler query.
Parameters	`osid.resourcing.rules.AvailabilityEnablerQuery`	`availabilityEnablerQuery`	the availability enabler query
Return	`osid.resourcing.rules.AvailabilityEnablerList`		the returned `AvailabilityEnablerList`
Errors	NULL_ARGUMENT		`availabilityEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.