OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.IssueLookupSession
Implementsosid.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.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe front office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupIssues
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeIssueView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryIssueView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedFrontOfficeView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFrontOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this front office only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveIssueView
Description

Only issues whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveIssueView
Description

All issues of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetIssue
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.

Parametersosid.id.IdissueIdthe Id of the Issue to retrieve
Returnosid.tracking.Issuethe returned Issue
ErrorsNOT_FOUNDno Issue found with the given Id
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByIds
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.

Parametersosid.id.IdListissueIdsthe list of Ids to retrieve
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT issueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByGenusType
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.

Parametersosid.type.TypeissueGenusTypean issue genus type
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNULL_ARGUMENT issueGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByParentGenusType
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.

Parametersosid.type.TypeissueGenusTypean issue genus type
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNULL_ARGUMENT issueGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByRecordType
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.

Parametersosid.type.TypeissueRecordTypean issue record type
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNULL_ARGUMENT issueRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesOnDate
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.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.tracking.IssueListthe returned Issue list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesForQueue
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.

Parametersosid.id.IdqueueIda queue Id
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesForQueueOnDate
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.

Parametersosid.id.IdqueueIda queue Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.tracking.IssueListthe returned Issue list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT queueId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesForCustomer
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesForCustomerOnDate
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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.tracking.IssueListthe returned Issue list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesForQueueAndCustomer
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.

Parametersosid.id.IdqueueIda queue Id
osid.id.IdresourceIda resource Id
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNULL_ARGUMENT queueId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesForQueueAndCustomerOnDate
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.

Parametersosid.id.IdqueueIda queue Id
osid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.tracking.IssueListthe returned Issue list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT queueId, resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssues
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.

Returnosid.tracking.IssueListthe returned Issue list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.