OSID - osid.learning.ProficiencySearchSession Service Interface Definition

Interface	osid.learning.ProficiencySearchSession
Implements	`osid.learning.ProficiencyQuerySession`
Used By	`osid.learning.LearningManager`
Used By	`osid.learning.LearningProxyManager`
Description	This session provides methods for searching among `Proficiencies`. The search query is constructed using the `ProficiencyQuery`. `getProficienciesByQuery()` is the basic search method and returns a list of `Proficiencies`. A more advanced search may be performed with `getProficienciesBySearch()`.It accepts a `ProficiencySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProficienciesBySearch()` returns a `ProficiencySearchResults` that can be used to access the resulting `ProficiencyList` or be used to perform a search within the result set through `ProficiencySearch`. This session defines views that offer differing behaviors for searching. federated objective bank view: searches include proficiencies in objective banks of which this objective bank is an ancestor in the obective bank hierarchy isolated objective bank view: searches are restricted to proficiencies in this objective bank Proficiencies may have a query record indicated by their respective record types. The query record is accessed via the `ProficiencyQuery`.
Method	getProficiencySearch
Description	Gets a proficiency search.
Return	`osid.learning.ProficiencySearch`		the proficiency search
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencySearchOrder
Description	Gets a proficiency search order. The `ProficiencySearchOrder` is supplied to a `ProficiencySearch` to specify the ordering of results.
Return	`osid.learning.ProficiencySearchOrder`		the proficiency search order
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.learning.ProficiencyQuery`	`proficiencyQuery`	the proficiency query
Parameters	`osid.learning.ProficiencySearch`	`proficiencySearch`	the proficiency search
Return	`osid.learning.ProficiencySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`proficiencyQuery` or `proficiencySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`proficiencyQuery` or `proficiencySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyQueryFromInspector
Description	Gets a proficiency query from an inspector. The inspector is available from a `ProficiencySearchResults`.
Parameters	`osid.learning.ProficiencyQueryInspector`	`proficiencyQueryInspector`	a proficiency query inspector
Return	`osid.learning.ProficiencyQuery`		the proficiency query
Errors	NULL_ARGUMENT		`proficiencyQueryInspector` is `null`
Errors	UNSUPPORTED		`proficiencyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.