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

This session provides methods to retrieve IssueProcessor to Oubliette mappings. An IssueProcessor may appear in multiple Oubliettes . 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
MethodcanLookupIssueProcessorOublietteMappings
Description

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

A complete view of the IssueProcessor 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.
MethodgetIssueProcessorIdsByOubliette
Description

Gets the list of IssueProcessorIds associated with an Oubliette .

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

Gets the list of IssueProcessors associated with an Oubliette .

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

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

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

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

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

Gets the Oubliette Ids mapped to an IssueProcessor .

Parametersosid.id.IdissueProcessorIdId of an IssueProcessor
Returnosid.id.IdListlist of oubliette Ids
ErrorsNOT_FOUNDissueProcessorId is not found
NULL_ARGUMENTissueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByIssueProcessor
Description

Gets the Oubliettes mapped to an IssueProcessor .

Parametersosid.id.IdissueProcessorIdId of an IssueProcessor
Returnosid.hold.OublietteListlist of oubliettes
ErrorsNOT_FOUNDissueProcessorId is not found
NULL_ARGUMENTissueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.