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

This session defines methods for routing issues.

This lookup session defines several views:

  • 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.

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

Tests if this user can route 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 routing operations to unauthorized users.

Returnboolean false if routing methods are not authorized, true otherwise
CompliancemandatoryThis method 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.
MethodmoveIssueToQueue
Description

Moves an Issue to another Queue. If the assigned resource is not valid in the destination queue, the issue may automatically be unassigned. If the assigned topic is not valid in the destination queue, it may default to another topic.

Parametersosid.id.IdissueIdthe Id of the Issue
osid.id.IdqueueIdthe Id of the Queue
ErrorsALREADY_EXISTS issueId already in queueId
NOT_FOUND issueId or queueId not found
NULL_ARGUMENT issueId or queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssignableTopicIds
Description

Gets a list of assignable topic Ids for a queue.

Parametersosid.id.IdqueueIdthe Id of the Queue
Returnosid.id.IdLista list of subject Ids
ErrorsNOT_FOUND queueId not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssignableTopics
Description

Gets a list of assignable topics for a queue.

Parametersosid.id.IdqueueIdthe Id of the Queue
Returnosid.ontology.SubjectLista list of subjects
ErrorsNOT_FOUND queueId not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodassignTopic
Description

Assigns a Topic to an Issue.

Parametersosid.id.IdissueIdthe Id of the Issue
osid.id.IdsubjectIdthe Id of the Subject
ErrorsALREADY_EXISTS issueId already assigned to subjectId
NOT_FOUND issueId or subjectId not found
NULL_ARGUMENT issueId or subjectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcloseIssue
Description

Closes an issue.

Parametersosid.id.IdissueIdthe Id of the Issue
ErrorsNOT_FOUND issueId not found
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.