OSID - osid.journaling.BranchSearchResults Service Interface Definition

Interface	osid.journaling.BranchSearchResults
Implements	`osid.OsidSearchResults`
Used By	`osid.journaling.BranchSearchSession`
Description	This interface provides a means to capture results of a search.
Method	getBranches
Description	Gets the branch list resulting from a search.
Return	`osid.journaling.BranchList`		the branch list
Errors	ILLEGAL_STATE		list already retrieved
Compliance	`mandatory`		This method must be implemented.
Method	getBranchQueryInspector
Description	Gets the inspector for the query to examine the terms used in the search.
Return	`osid.journaling.BranchQueryInspector`		the branch query inspector
Compliance	`mandatory`		This method must be implemented.
Method	getBranchSearchResultsRecord
Description	Gets the branch search results record corresponding to the given branch search record `Type`.This method is used to retrieve an object implementing the requested record.
Parameters	`osid.type.Type`	`branchSearchRecordType`	a branch search record type
Return	`osid.journaling.records.BranchSearchResultsRecord`		the branch search results record
Errors	NULL_ARGUMENT		`branchSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordTypeType(branchSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.