OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Interfaceosid.hold.rules.IssueConstrainerOublietteSession
Implementsosid.OsidSession
Used Byosid.hold.rules.HoldRulesManager
osid.hold.rules.HoldRulesProxyManager
Description

This session provides methods to retrieve IssueConstrai ner to Oubliette mappings. An IssueConstrai ner 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
MethodcanLookupIssueConstrainerOublietteMappings
Description

Tests if this user can perform lookups of issue constrainer/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. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnbooleanfalse if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeIssueConstrainerOublietteView
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.
MethodusePlenaryIssueConstrainerOublietteView
Description

A complete view of the IssueConstrainer 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.
MethodgetIssueConstrainerIdsByOubliette
Description

Gets the list of IssueConstrainerIds associated with an Oubliette .

Parametersosid.id.IdoublietteIdId of the Oubliette
Returnosid.id.IdListlist of related issue constrainer Ids
ErrorsNOT_FOUNDoublietteId is not found
NULL_ARGUMENToublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssueConstrainersByOubliette
Description

Gets the list of IssueConstrainers associated with an Oubliette .

Parametersosid.id.IdoublietteIdId of the Oubliette
Returnosid.hold.rules.IssueConstrainerListlist of related issue constrainers
ErrorsNOT_FOUNDoublietteId is not found
NULL_ARGUMENToublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssueConstrainerIdsByOubliettes
Description

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

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

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

Parametersosid.id.IdListoublietteIdslist of oubliette Ids
Returnosid.hold.rules.IssueConstrainerListlist of issue constrainer Ids
ErrorsNULL_ARGUMENToublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOublietteIdsByIssueConstrainer
Description

Gets the Oubliette Ids mapped to an IssueConstrainer .

Parametersosid.id.IdissueConstrainerIdId of an IssueConstrainer
Returnosid.id.IdListlist of oubliette Ids
ErrorsNOT_FOUNDissueConstrainerId is not found
NULL_ARGUMENTissueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByIssueConstrainer
Description

Gets the Oubliettes mapped to an IssueConstrainer .

Parametersosid.id.IdissueConstrainerIdId of an IssueConstrainer
Returnosid.hold.OublietteListlist of oubliettes
ErrorsNOT_FOUNDissueConstrainerId is not found
NULL_ARGUMENTissueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.