OSID - osid.journaling.BranchSearchSession Service Interface Definition

Interface	osid.journaling.BranchSearchSession
Implements	`osid.journaling.BranchQuerySession`
Description	This session provides methods for searching among `Branch` objects. The search query is constructed using the `BranchQuery.` `getBranchsByQuery()` is the basic search method and returns a list of `Branches.` A more advanced search may be performed with `getBranchesBySearch().` It accepts an `BranchSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBranchesBySearch()` returns an `BranchSearchResults` that can be used to access the resulting `BranchList` or be used to perform a search within the result set through `BranchList.` This session defines views that offer differing behaviors for searching. federated journal view: searches include branches in journals of which this journal is a ancestor in the journal hierarchy isolated journal view: searches are restricted to branches in this journal Branches may have a query record indicated by their respective recod types. The query record is accessed via the `BranchQuery.`
Method	getBranchSearch
Description	Gets a branch search.
Return	`osid.journaling.BranchSearch`		the branch search
Compliance	`mandatory`		This method must be implemented.
Method	getBranchSearchOrder
Description	Gets a branch search order. The `BranchSearchOrder` is supplied to a `BranchSearch` to specify the ordering of results.
Return	`osid.journaling.BranchSearchOrder`		the branch search order
Compliance	`mandatory`		This method must be implemented.
Method	getBranchesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.journaling.BranchQuery`	`branchQuery`	the branch query
Parameters	`osid.journaling.BranchSearch`	`branchSearch`	the branch search
Return	`osid.journaling.BranchSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`branchQuery` or `branchSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`branchQuery` or `branchSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBranchQueryFromInspector
Description	Gets a branch query from an inspector. The inspector is available from a `BranchSearchResults.`
Parameters	`osid.journaling.BranchQueryInspector`	`branchQueryInspector`	a branch query inspector
Return	`osid.journaling.BranchQuery`		the branch query
Errors	NULL_ARGUMENT		`branchQueryInspector` is `null`
Errors	UNSUPPORTED		`branchQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.