OSID - osid.journaling.BranchQuerySession Service Interface Definition

Interface	osid.journaling.BranchQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.journaling.BranchSearchSession`
Used By	`osid.journaling.JournalingManager`
Used By	`osid.journaling.JournalingProxyManager`
Description	This session provides methods for searching among `Branches`. The search query is constructed using the `BranchQuery`. 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 record types. The query record is accessed via the `BranchQuery`.
Method	getJournalId
Description	Gets the `Journal` `Id` associated with this session.
Return	`osid.id.Id`		the `Journal Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJournal
Description	Gets the `Journal` associated with this session.
Return	`osid.journaling.Journal`		the `Journal` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchBranches
Description	Tests if this user can perform `Branch` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedJournalView
Description	Federates the view for methods in this session. A federated view will include branches in journals which are children of this journal in the journal hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedJournalView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this journal only.
Compliance	`mandatory`		This method is must be implemented.
Method	getBranchQuery
Description	Gets a branch query. The returned query will not have an extension query.
Return	`osid.journaling.BranchQuery`		the branch query
Compliance	`mandatory`		This method must be implemented.
Method	getBranchesByQuery
Description	Gets a list of `Branches` matching the given branch query.
Parameters	`osid.journaling.BranchQuery`	`branchQuery`	the branch query
Return	`osid.journaling.BranchList`		the returned `BranchList`
Errors	NULL_ARGUMENT		`branchQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`branchQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.