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

This session provides methods to retrieve IssueConstrainerEnabler to Oubliette mappings. An IssueConstrainerEnabler may appear in multiple Oubliettes. Each oub liette 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
MethodcanLookupIssueConstrainerEnablerOublietteMappings
Description

Tests if this user can perform lookups of issue constrainer enabler/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.
MethoduseComparativeIssueConstrainerEnablerOublietteView
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.
MethodusePlenaryIssueConstrainerEnablerOublietteView
Description

A complete view of the IssueConstrainerEnabler 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.
MethodgetIssueConstrainerEnablerIdsByOubliette
Description

Gets the list of IssueConstrainerEnablerIds associated with an Oubliette .

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

Gets the list of IssueConstrainerEnablers associated with an Oubliette .

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

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

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

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

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

Gets the Oubliette Ids mapped to an IssueConstrainerEnabler .

Parametersosid.id.IdissueConstrainerEnablerIdId of an IssueConstrainerEnabler
Returnosid.id.IdListlist of oubliette Ids
ErrorsNOT_FOUNDissueConstrainerEnablerId is not found
NULL_ARGUMENTissueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByIssueConstrainerEnabler
Description

Gets the Oubliettes mapped to an IssueConstrainerEnabler .

Parametersosid.id.IdissueConstrainerEnablerIdId of an IssueConstrainerEnabler
Returnosid.hold.OublietteListlist of oubliettes
ErrorsNOT_FOUNDissueConstrainerEnablerId is not found
NULL_ARGUMENTissueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.