OSID - osid.journaling.BranchLookupSession Service Interface Definition

Interface	osid.journaling.BranchLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving branches. A `Branch` is an arbitrary entity that may represent a person, place or thing used to identify an object used in various services. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated journal view: All branch methods in this session operate, retrieve and pertain to branches defined explicitly in the current journal. Using an isolated view is useful for managing `Branches` with the `BranchAdminSession.` federated journal view: All branch methods in this session operate, retrieve and pertain to all branches defined in this journal and any other branches implicitly available in this journal through journal inheritence. active branch view: Active brcnhes are returned in this session. any status branch view: Active and inactive branches are returned in this session. The methods `useFederatedJournalView()` and `useIsolatedJournalView()` behave as a radio group and one should be selected before invoking any lookup methods. Branches may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Branch.`
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	canLookupBranches
Description	Tests if this user can perform `Branch` lookups. 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 lookup operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBranchView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBranchView
Description	A complete view of the `Branch` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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	useActiveBranchView
Description	Methods return only branches that are active.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusBranchView
Description	Actuve and inactive branches are returned from lookup methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBranch
Description	Gets the `Branch` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Branch` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Branch` and retained for compatibility.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the `Branch` to retrieve
Return	`osid.journaling.Branch`		the returned `Branch`
Errors	NOT_FOUND		no `Branch` found with the given `Id`
	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBranchesByIds
Description	Gets a `BranchList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the branches specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Branches` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`branchIds`	the list of `Ids` to retrieve
Return	`osid.journaling.BranchList`		the returned `Branch` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`branchIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBranchesByGenusType
Description	Gets a `BranchList` corresponding to the given branch genus `Type` which does not include branches of types derived from the specified `Type.` In plenary mode, the returned list contains all known branches or an error results. Otherwise, the returned list may contain only those branches that are accessible through this session.
Parameters	`osid.type.Type`	`branchGenusType`	a branch genus type
Return	`osid.journaling.BranchList`		the returned `Branch` list
Errors	NULL_ARGUMENT		`branchGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBranchesByParentGenusType
Description	Gets a `BranchList` corresponding to the given branch genus `Type` and include any additional branches with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known branches or an error results. Otherwise, the returned list may contain only those branches that are accessible through this session.
Parameters	`osid.type.Type`	`branchGenusType`	a branch genus type
Return	`osid.journaling.BranchList`		the returned `Branch` list
Errors	NULL_ARGUMENT		`branchGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBranchesByRecordType
Description	Gets a `BranchList` containing the given branch record `Type.` In plenary mode, the returned list contains all known branches or an error results. Otherwise, the returned list may contain only those branches that are accessible through this session.
Parameters	`osid.type.Type`	`branchRecordType`	a branch record type
Return	`osid.journaling.BranchList`		the returned `Branch` list
Errors	NULL_ARGUMENT		`branchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBranches
Description	Gets all `Branches.` In plenary mode, the returned list contains all known branches or an error results. Otherwise, the returned list may contain only those branches that are accessible through this session.
Return	`osid.journaling.BranchList`		a list of `Branches`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.