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

This session provides methods to retrieve IssueprocessorEnabler to Oubliette mappings. An IssueProcessorEnabler 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
MethodcanLookupIssueProcessorEnablerOublietteMappings
Description

Tests if this user can perform lookups of issue processor 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.
MethoduseComparativeIssueProcessorEnablerOublietteView
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.
MethodusePlenaryIssueProcessorEnablerOublietteView
Description

A complete view of the IssueProcessorEnabler 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.
MethodgetIssueProcessorEnablerIdsByOubliette
Description

Gets the list of IssueProcessorEnablerIds associated with an Oubliette .

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

Gets the list of IssueProcessorEnablers associated with an Oubliette .

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

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

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

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

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

Gets the Oubliette Ids mapped to an IssueProcessorEnabler .

Parametersosid.id.IdissueProcessorEnablerIdId of an IssueProcessorEnabler
Returnosid.id.IdListlist of oubliette Ids
ErrorsNOT_FOUNDissueProcessorEnablerId is not found
NULL_ARGUMENTissueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByIssueProcessorEnabler
Description

Gets the Oubliettes mapped to an IssueProcessorEnabler .

Parametersosid.id.IdissueProcessorEnablerIdId of an IssueProcessorEnabler
Returnosid.hold.OublietteListlist of oubliettes
ErrorsNOT_FOUNDissueProcessorEnablerId is not found
NULL_ARGUMENTissueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.