OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.IssueTrackingSession
Implementsosid.OsidSession
Description

This session defines methods for looking at issues in a queue.

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.
MethodgetIssue
Description

Gets the Issue specified by its Id.

Parametersosid.id.IdissueIdthe Id of the Issue to retrieve
Returnosid.tracking.Issuethe returned Issue
ErrorsNOT_FOUNDno Issue found in this queue with the given Id
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOpenIssues
Description

Gets a list of all open issues in a queue.

Parametersosid.id.IdqueueIdthe Id of a Queue to
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOpenUnassignedIssues
Description

Gets a list of all open unassigned issues in this queue.

Parametersosid.id.IdqueueIdthe Id of a Queue to
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOpenIdleIssues
Description

Gets a list of open issues that have been idle since the given date.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.calendaring.DateTimedatea date
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOpenIssuesByAssignee
Description

Gets a list of open issues assigned to the given resource.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.id.IdresourceIda resource
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOpenIssuesByTopic
Description

Gets a list of issues by topic which may include issues of any child topic.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.id.IdsubjectIda resource
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or subjectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetClosedIssues
Description

Gets a list of all closed issues in this queue.

Parametersosid.id.IdqueueIdthe Id of a Queue to
Returnosid.tracking.IssueListthe returned Issue list
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetClosedIssuesByAssignee
Description

Gets a list of closed issues that were ever assigned to the given resource.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.id.IdresourceIda resource
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetClosedIssuesByTopic
Description

Gets a list of issues by topic which may include issues of any child topic.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.id.IdtopicIda resource
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or topicId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetClosedIssuesByCreateDate
Description

Gets a list of closed issues that were created between the given date range inclusive.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.tracking.IssueListthe returned IssueList
ErrorsINVALID_ARGUMENT from is greater than to
NOT_FOUND queueId is not found
NULL_ARGUMENT queueId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByActiveDate
Description

Gets a list of all issues that were in an open status on the given date.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.calendaring.DateTimedatea date
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesSinceDate
Description

Gets a list of all issues created since the given date.

Parametersosid.id.IdqueueIdthe Id of a Queue to
osid.calendaring.DateTimedatea date
Returnosid.tracking.IssueListthe returned IssueList
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId or date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.