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

This session provides methods to retrieve IssueEnabler to Oubliette mappings. An IssueEnabler 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
MethodcanLookupIssueEnablerOublietteMappings
Description

Tests if this user can perform lookups of issue 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.
MethoduseComparativeIssueEnablerOublietteView
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.
MethodusePlenaryIssueEnablerOublietteView
Description

A complete view of the IssueEnabler 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.
MethodgetIssueEnablerIdsByOubliette
Description

Gets the list of IssueEnabler Ids associated with an Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.id.IdList list of related issue 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.
MethodgetIssueEnablersByOubliette
Description

Gets the list of IssueEnablers associated with an Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.hold.rules.IssueEnablerList list of related issue 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.
MethodgetIssueEnablerIdsByOubliettes
Description

Gets the list of IssueEnabler Ids corresponding to a list of Oubliettes.

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

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

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

Gets the Oubliette Ids mapped to an IssueEnabler.

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

Gets the Oubliettes mapped to an IssueEnabler.

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