OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueOublietteSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Issue to Oubliette issues. An Issue may appear in multiple Oubliette objects. Each oubliette 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
MethodcanLookupIssueOublietteIssues
Description

Tests if this user can perform lookups of issue/oubliette 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 issues is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeIssueOublietteView
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.
MethodusePlenaryIssueOublietteView
Description

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

Gets the list of Issue Ids associated with a Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.id.IdListlist of related issue Ids
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByOubliette
Description

Gets the list of Issues associated with a Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.hold.IssueListlist of related issues
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssueIdsByOubliettes
Description

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

Parametersosid.id.IdListoublietteIdslist of oubliette Ids
Returnosid.id.IdListlist of issue Ids
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssuesByOubliettes
Description

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

Parametersosid.id.IdListoublietteIdslist of oubliette Ids
Returnosid.hold.IssueListlist of issues
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOublietteIdsByIssue
Description

Gets the Oubliette Ids mapped to an Issue.

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

Gets the Oubliettes mapped to an Issue.

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