OSID - osid.journaling.BranchSmartJournalSession Service Interface Definition

Interface	osid.journaling.BranchSmartJournalSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `BranchQuery` can be retrieved from this session and mapped to this `Journal` to create a virtual collection of `Branches.` The branches may be sequenced using the `BranchSearchOrder` from this session. This `Journal` has a default query that matches any branch and a default search order that specifies no sequencing. The queries may be examined using a `BranchQueryInspector.` The query may be modified by converting the inspector back to a `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	canManageSmartJournals
Description	Tests if this user can manage smart journals. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart journal management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBranchQuery
Description	Gets a branch query.
Return	`osid.journaling.BranchQuery`		the branch query
Compliance	`mandatory`		This method must be implemented.
Method	getBranchSearchOrder
Description	Gets a branch search order.
Return	`osid.journaling.BranchSearchOrder`		the branch search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBranchQuery
Description	Applies a branch query to this journal.
Parameters	`osid.journaling.BranchQuery`	`branchQuery`	the branch query
Errors	NULL_ARGUMENT		`branchQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`branchQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBranchQuery
Description	Gets a branch query inspector for this journal.
Return	`osid.journaling.BranchQueryInspector`		the branch query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBranchSequencing
Description	Applies a branch search order to this journal.
Parameters	`osid.journaling.BranchSearchOrder`	`branchSearchOrder`	the branch search order
Errors	NULL_ARGUMENT		`branchSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`branchSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBranchQueryFromInspector
Description	Gets a branch query from an inspector.
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.