OSID - osid.assessment.BankSearchSession Service Interface Definition

Interface	osid.assessment.BankSearchSession
Implements	`osid.assessment.BankQuerySession`
Description	This session provides methods for searching among `Bank` objects. The search query is constructed using the `BankQuery.` `getBanksByQuery()` is the basic search method and returns a list of `Bank` objects.A more advanced search may be performed with `getBanksBySearch().` It accepts a `BankSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBanksBySearch()` returns a `BankSearchResults` that can be used to access the resulting `BankList` or be used to perform a search within the result set through `BankSearch.` Banks may have a query record indicated by their respective record types. The query record is accessed via the `BankQuery.`
Method	getBankSearch
Description	Gets a bank search.
Return	`osid.assessment.BankSearch`		a bank search
Compliance	`mandatory`		This method must be implemented.
Method	getBankSearchOrder
Description	Gets a bank search order. The `BankSearchOrder` is supplied to a `BankSearch` to specify the ordering of results.
Return	`osid.assessment.BankSearchOrder`		the bank search order
Compliance	`mandatory`		This method must be implemented.
Method	getBanksBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.assessment.BankQuery`	`bankQuery`	the bank query
Parameters	`osid.assessment.BankSearch`	`bankSearch`	the bank search
Return	`osid.assessment.BankSearchResults`		the bank search results
Errors	NULL_ARGUMENT		`bankQuery` or `bankSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`bankQuery` or `bankSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBankQueryFromInspector
Description	Gets a bank query from an inspector. The inspector is available from a `BankSearchResults.`
Parameters	`osid.assessment.BankQueryInspector`	`bankQueryInspector`	a bank query inspector
Return	`osid.assessment.BankQuery`		the bank query
Errors	NULL_ARGUMENT		`bankQueryInspector` is `null`
Errors	UNSUPPORTED		`bankQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.