OSID Logo
OSID Specifications
hold rules package
Version 3.1.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.

Returnboolean false if looking up mappings is not authorized, true otherwise
Compliancemandatory This 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.

Compliancemandatory This 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.

Compliancemandatory This method is must be implemented.
MethodgetIssueProcessorEnablerIdsByOubliette
Description

Gets the list of IssueProcessorEnablerIds associated with an Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.id.IdList list of related issue processor enabler Ids
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetIssueProcessorEnablersByOubliette
Description

Gets the list of IssueProcessorEnablers associated with an Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.hold.rules.IssueProcessorEnablerList list of related issue processor enablers
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetIssueProcessorEnablerIdsByOubliettes
Description

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

Parametersosid.id.IdListoublietteIds list of oubliette Ids
Returnosid.id.IdList list of issue processor enabler Ids
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetIssueProcessorEnablersByOubliettes
Description

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

Parametersosid.id.IdListoublietteIds list of oubliette Ids
Returnosid.hold.rules.IssueProcessorEnablerList list of issue processor enablers
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetOublietteIdsByIssueProcessorEnabler
Description

Gets the Oubliette Ids mapped to an IssueProcessorEnabler.

Parametersosid.id.IdissueProcessorEnablerId Id of an IssueProcessorEnabler
Returnosid.id.IdList list of oubliette Ids
ErrorsNOT_FOUND issueProcessorEnablerId is not found
NULL_ARGUMENT issueProcessorEnablerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetOubliettesByIssueProcessorEnabler
Description

Gets the Oubliettes mapped to an IssueProcessorEnabler.

Parametersosid.id.IdissueProcessorEnablerId Id of an IssueProcessorEnabler
Returnosid.hold.OublietteList list of oubliettes
ErrorsNOT_FOUND issueProcessorEnablerId is not found
NULL_ARGUMENT issueProcessorEnablerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.