OSID - osid.course.ActivityUnitSearchSession Service Interface Definition

Interface	osid.course.ActivityUnitSearchSession
Implements	`osid.course.ActivityUnitQuerySession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session provides methods for searching among `ActivityUnits` . The search query is constructed using the `ActivityUnitQuery` . `getActivityUnitsByQuery()` is the basic search method and returns a list of `ActivityUnits` . A more advanced search may be performed with `getActivityUnitsBySearch()` .It accepts an `ActivityUnitSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getActivityUnitsBySearch()` returns an `ActivityUnitSearchResults` that can be used to access the resulting `ActivityUnitList` or be used to perform a search within the result set through `ActivityUnitSearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include activity units in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to activity units in this course catalog Activity Units may have a query record indicated by their respective record types. The query record is accessed via the `ActivityUnitQuery` .
Method	getActivityUnitSearch
Description	Gets an activity unit search.
Return	`osid.course.ActivityUnitSearch`		the activity unit search
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitSearchOrder
Description	Gets an activity search order. The `ActivityUnitSearchOrder` is supplied to an `ActivityUnitSearch` to specify the ordering of results.
Return	`osid.course.ActivityUnitSearchOrder`		the activity unit search order
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.ActivityUnitQuery`	`activityUnitQuery`	the activity unit query
Parameters	`osid.course.ActivityUnitSearch`	`activityUnitSearch`	the activity unit search
Return	`osid.course.ActivityUnitSearchResults`		the activity unit search results
Errors	NULL_ARGUMENT		`activityUnitQuery` or `activityUnitSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityUnitQuery` or `activityUnitSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitQueryFromInspector
Description	Gets an activity unit query from an inspector. The inspector is available from an `ActivityUnitSearchResults` .
Parameters	`osid.assessment.ItemQueryInspector`	`activityUnitQueryInspector`	an activity unit query inspector
Return	`osid.course.ActivityUnitQuery`		the activity unit query
Errors	NULL_ARGUMENT		`activityUnitQueryInspector` is `null`
Errors	UNSUPPORTED		`activityUnitQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.