OSID - osid.tracking.BranchedIssueLookupSession Service Interface Definition

Interface	osid.tracking.BranchedIssueLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving branched issues. 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 front office view: All issue methods in this session operate, retrieve and pertain to issues defined explicitly in the current front office. Using an isolated view is useful for managing `Issues` with the `IssueAdminSession.` federated front office view: All issue lookup methods in this session operate, retrieve and pertain to all issues defined in this front office and any other issues implicitly available in this front office through front office inheritence. The methods `useFederatedFrontOfficeView()` and `useIsolatedFrontOfficeView()` behave as a radio group and one should be selected before invoking any lookup methods. Issues may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Issues.`
Method	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the front office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupBranchedIssues
Description	Tests if this user can perform branched `Issue` 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeIssueView
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	usePlenaryIssueView
Description	A complete view of the `Issue` 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	useFederatedFrontOfficeView
Description	Federates the view for methods in this session. A federated view will include issues in front offices which are children of this front office in the front office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFrontOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this front office only.
Compliance	`mandatory`		This method is must be implemented.
Method	getBranchedIssueIds
Description	Gets any branched issues off of the given `Issue.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Issue` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Issue` and retained for compatibility.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue`
Return	`osid.id.IdList`		the returned branched issue `Ids`
Errors	NOT_FOUND		no `Issue` found with the given `Id`
	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBranchedIssues
Description	Gets any branched issues off of the given `Issue.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Issue` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Issue` and retained for compatibility.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue`
Return	`osid.tracking.IssueList`		the returned branched issues
Errors	NOT_FOUND		no `Issue` found with the given `Id`
	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.