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

This session provides methods to retrieve Issue to FrontOffice mappings. An Issue may appear in multiple FrontOffice objects. Each front office may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupIssueFrontOfficeMappings
Description

Tests if this user can perform lookups of issue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeIssueFrontOfficeView
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.
MethodusePlenaryIssueFrontOfficeView
Description

A complete view of the Issue and FrontOffice 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.
MethodgetIssueIdsByFrontOffice
Description

Gets the list of Issue Ids associated with a FrontOffice.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.id.IdListlist of related issue Ids
ErrorsNOT_FOUND frontOfficeId is not found
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByFrontOffice
Description

Gets the list of Issues associated with a FrontOffice.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.tracking.IssueListlist of related issues
ErrorsNOT_FOUND frontOfficeId is not found
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssueIdsByFrontOffices
Description

Gets the list of Issue Ids corresponding to a list of FrontOffices.

Parametersosid.id.IdListfrontOfficeIdslist of front office Ids
Returnosid.id.IdListlist of issue Ids
ErrorsNULL_ARGUMENT frontOfficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByFrontOffices
Description

Gets the list of Issues corresponding to a list of FrontOffices.

Parametersosid.id.IdListfrontOfficeIdslist of front office Ids
Returnosid.tracking.IssueListlist of issues
ErrorsNULL_ARGUMENT frontOfficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeIdsByIssue
Description

Gets the FrontOffice Ids frontOfficeped to an Issue.

Parametersosid.id.IdissueId Id of an Issue
Returnosid.id.IdListlist of frontOffices
ErrorsNOT_FOUND issueId is not found
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByIssue
Description

Gets the FrontOffices frontOfficeped to an Issue.

Parametersosid.id.IdissueId Id of an Issue
Returnosid.tracking.FrontOfficeListlist of frontOffices
ErrorsNOT_FOUND issueId is not found
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.