OSID - osid.resourcing.EffortQuerySession Service Interface Definition

Interface	osid.resourcing.EffortQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Effort` objects. The search query is constructed using the `EffortQuery.` This session defines views that offer differing behaviors for searching. federated foundry view: searches include efforts in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to efforts in this foundry Efforts may have a query record indicated by their respective record types. The query record is accessed via the `EffortQuery.`
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	canSearchEfforts
Description	Tests if this user can perform `Effort` 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 efforts 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 searches to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	getEffortQuery
Description	Gets an effort query.
Return	`osid.resourcing.EffortQuery`		the effort query
Compliance	`mandatory`		This method must be implemented.
Method	getEffortsByQuery
Description	Gets a list of `Efforts` matching the given effort query.
Parameters	`osid.resourcing.EffortQuery`	`effortQuery`	the effort query
Return	`osid.resourcing.EffortList`		the returned `EffortList`
Errors	NULL_ARGUMENT		`effortQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`effortQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.