OSID - osid.learning.ObjectiveSearchSession Service Interface Definition

Interface	osid.learning.ObjectiveSearchSession
Implements	`osid.learning.ObjectiveQuerySession`
Description	This session provides methods for searching `Objective` objects. The search query is constructed using the `ObjectiveQuery.` The objective record `Type` also specifies the record for the objective query. `getObjectivesByQuery()` is the basic search method and returns a list of `Objectives.` A more advanced search may be performed with `getObjectivesBySearch().` It accepts a `ObjectiveSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getObjectivesBySearch()` returns an `ObjectiveSearchResults` that can be used to access the resulting `ObjectiveList` or be used to perform a search within the result set through `ObjectiveSearch.` This session defines views that offer differing behaviors for searching. federated objective bank view: searches include objectives in objective banks of which this objective bank is a ancestor in the objective bank hierarchy isolated objective bank view: searches are restricted to objectives in this objective bank Objectives may have a query record indicated by their respective record types. The query record is accessed via the `ObjectiveQuery.`
Method	getObjectiveSearch
Description	Gets an objective search.
Return	`osid.learning.ObjectiveSearch`		the objective search
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveSearchOrder
Description	Gets a n objective search order. The `ObjectiveSearchOrder` is supplied to an `ObjectiveSearch` to specify the ordering of results.
Return	`osid.learning.ObjectiveSearchOrder`		the objective search order
Compliance	`mandatory`		This method must be implemented.
Method	getObjectivesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.learning.ObjectiveQuery`	`objectiveQuery`	the objective search query
Parameters	`osid.learning.ObjectiveSearch`	`objectiveSearch`	the objective search
Return	`osid.learning.ObjectiveSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`objectiveQuery` or `objectiveSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`objectiveSearch` or `objectiveQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveQueryFromInspector
Description	Gets an objective query from an inspector. The inspector is available from an `ObjectiveSearchResults.`
Parameters	`osid.learning.ObjectiveQueryInspector`	`objectiveQueryInspector`	an objective bank query inspector
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	NULL_ARGUMENT		`objectiveQueryInspector` is `null`
Errors	UNSUPPORTED		`objectiveQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.