OSID - osid.journaling.BranchSearch Service Interface Definition

Interface	osid.journaling.BranchSearch
Implements	`osid.OsidSearch`
Used By	`osid.journaling.BranchSearchSession`
Description	The search interface for governing branch searches.
Method	searchAmongBranches
Description	Execute this search among the given list of branches.
Parameters	`osid.id.IdList`	`branchIds`	list of branch `Ids`
Errors	NULL_ARGUMENT		`branchIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBranchResults
Description	Specify an ordering to the search results.
Parameters	`osid.journaling.BranchSearchOrder`	`branchSearchOrder`	branch search order
Errors	NULL_ARGUMENT		`order` is `null`
Errors	UNSUPPORTED		`order` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBranchSearchRecord
Description	Gets the branch search 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.BranchSearchRecord`		the branch search record
Errors	NULL_ARGUMENT		`branchSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordTypeType(branchSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.