OSID - osid.learning.ActivityQuerySession Service Interface Definition

Interface	osid.learning.ActivityQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Activity` objects. The search query is constructed using the `ActivityQuery.` The activity record `Type` also specifies the record for the activity query. This session defines views that offer differing behaviors for searching. federated objective bank view: searches include activities in objective banks of which this objective bank is a ancestor in the objective bank hierarchy isolated objective bank view: searches are restricted to activities in this objective bank Activities may have a query record indicated by their respective record types. The query record is accessed via the `ActivityQuery.`
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the `ObjectiveBank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchActivities
Description	Tests if this user can perform `Activity` searches. 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 opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedObjectiveBankView
Description	Federates the view for methods in this session. A federated view will include activities in objective banks which are children of this objective bank in the objective bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedObjectiveBankView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this objective bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getActivityQuery
Description	Gets an activity query.
Return	`osid.learning.ActivityQuery`		the activity query
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesByQuery
Description	Gets a list of `Activities` matching the given activity query.
Parameters	`osid.learning.ActivityQuery`	`activityQuery`	the activity query
Return	`osid.learning.ActivityList`		the returned `ActivityList`
Errors	NULL_ARGUMENT		`activityQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.