OSID - osid.tracking.IssueLookupSession Service Interface Definition

Interface	osid.tracking.IssueLookupSession
Implements	`osid.OsidSession`
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 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. effective issue view: All issue lookup methods return issues where the current date falls in between the effective dates inclusive. any effective issue view: Issues of any effective date are returned from methods. 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	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	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	useEffectiveIssueView
Description	Only issues whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveIssueView
Description	All issues of any effective dates are returned by 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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to retrieve
Return	`osid.tracking.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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.IdList`	`issueIds`	the list of `Ids` to retrieve
Return	`osid.tracking.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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.type.Type`	`issueGenusType`	an issue genus type
Return	`osid.tracking.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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.type.Type`	`issueGenusType`	an issue genus type
Return	`osid.tracking.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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.type.Type`	`issueRecordType`	an issue record type
Return	`osid.tracking.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	getIssuesOnDate
Description	Gets a list of issues effective beginning in the date range. Issues are returned with a start effective date that falls between the requested dates inclusive. 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 effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesForQueue
Description	Gets a list of issues by queue. 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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesForQueueOnDate
Description	Gets a list of issues for a queue effective beginning in the date range. Issues are returned with a start effective date that falls between the requested dates inclusive. 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 effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`queueId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesForCustomer
Description	Gets a list of issues by customer. 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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.tracking.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	getIssuesForCustomerOnDate
Description	Gets a list of issues for a customer effective beginning in the date range. Issues are returned with a start effective date that falls between the requested dates inclusive. 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 effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesForQueueAndCustomer
Description	Gets a list of issues by queue and customer. 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 effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	NULL_ARGUMENT		`queueId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesForQueueAndCustomerOnDate
Description	Gets a list of issues for a queue and customer effective beginning in the date range. Issues are returned with a start effective date that falls between the requested dates inclusive. 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 effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`queueId, resourceId, from,` or `to` 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. In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned.
Return	`osid.tracking.IssueList`		the returned `Issue` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.