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

This session defines methods for retrieving blocking 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.

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

Tests if this user can perform blocking 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.
MethodgetBlockingIssueIds
Description

Gets any blocking issues of the given Issue. 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.

Parametersosid.id.IdissueIdthe Id of the Issue
Returnosid.id.IdListthe returned blocking issue Ids
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.
MethodgetBlockingIssues
Description

Gets any blocking issues of the given Issue. 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.

Parametersosid.id.IdissueIdthe Id of the Issue
Returnosid.tracking.IssueListthe returned blocking issues
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.
MethodgetBlockedIssueIds
Description

Gets any blocked issues as a result of the given Issue. 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.

Parametersosid.id.IdblockingIssueIdthe Id of the blocking Issue
Returnosid.id.IdListthe returned blocked issue Ids
ErrorsNOT_FOUNDno Issue found with the given Id
NULL_ARGUMENT blockingIssueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlockedIssues
Description

Gets any blocked issues as a result of the given Issue. 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.

Parametersosid.id.IdblockingIssueIdthe Id of the blocking Issue
Returnosid.tracking.IssueListthe returned blocked issues
ErrorsNOT_FOUNDno Issue found with the given Id
NULL_ARGUMENT blockingIssueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.