OSID - osid.hold.IssueLookupSession Service Interface Definition

Interface	osid.hold.IssueLookupSession
Implements	`osid.OsidSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session defines methods for retrieving 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 oubliette view: All issue methods in this session operate, retrieve and pertain to issues defined explicitly in the current oubliette. Using an isolated view is useful for managing `Issues` with the `IssueAdminSession`. federated oubliette view: All issue lookup methods in this session operate, retrieve and pertain to all issues defined in this oubliette and any other issues implicitly available in this oubliette through oubliette inheritence. active issue view: active issues are returned from methods in this session any status issue view: active and inactive issues are returned from methods in this session The methods `useFederatedOublietteView()` and `useIsolatedOublietteView()` 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	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupIssues
Description	Tests if this user can perform `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	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include issues in oubliettes which are children of this oubliette in the oubliette hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOublietteView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveIssueView
Description	Only active issues are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusIssueView
Description	Borth active and inactive issues are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getIssue
Description	Gets the `Issue` specified by its `Id`. 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. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to retrieve
Return	`osid.hold.Issue`		the returned `Issue`
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	getIssuesByIds
Description	Gets an `IssueList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the issues 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 `Issues` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Parameters	`osid.id.IdList`	`issueIds`	the list of `Ids` to retrieve
Return	`osid.hold.IssueList`		the returned `Issue` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`issueIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesByGenusType
Description	Gets an `IssueList` corresponding to the given issue genus `Type` which does not include issues of types derived from the specified `Type`. In plenary mode, the returned list contains all known issues or an error results. Otherwise, the returned list may contain only those issues that are accessible through this session. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Parameters	`osid.type.Type`	`issueGenusType`	an issue genus type
Return	`osid.hold.IssueList`		the returned `Issue` list
Errors	NULL_ARGUMENT		`issueGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesByParentGenusType
Description	Gets an `IssueList` corresponding to the given issue genus `Type` and include any additional issues with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known issues or an error results. Otherwise, the returned list may contain only those issues that are accessible through this session. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Parameters	`osid.type.Type`	`issueGenusType`	an issue genus type
Return	`osid.hold.IssueList`		the returned `Issue` list
Errors	NULL_ARGUMENT		`issueGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesByRecordType
Description	Gets an `IssueList` containing the given issue record `Type`. In plenary mode, the returned list contains all known issues or an error results. Otherwise, the returned list may contain only those issues that are accessible through this session. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Parameters	`osid.type.Type`	`issueRecordType`	an issue record type
Return	`osid.hold.IssueList`		the returned `Issue` list
Errors	NULL_ARGUMENT		`issueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesByBureau
Description	Gets an `IssueList` by `Bureau`. In plenary mode, the returned list contains all known issues or an error results. Otherwise, the returned list may contain only those issues that are accessible through this session. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.hold.IssueList`		the returned `Issue` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssues
Description	Gets all issues. In plenary mode, the returned list contains all of the issues, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Issues` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, issues are returned that are currently active. In any status mode, active and inactive issues are returned.
Return	`osid.hold.IssueList`		the returned `Issue` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.