OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.BlockOublietteSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Block to Oubliette holds. A Block 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
MethodcanLookupBlockOublietteMappings
Description

Tests if this user can perform lookups of block/oubliette holds. 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. This 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
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBlockOublietteView
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.
MethodusePlenaryBlockOublietteView
Description

A complete view of the Block 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.
MethodgetBlockIdsByOubliette
Description

Gets the list of Block Ids associated with a Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.id.IdListlist of related block Ids
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlocksByOubliette
Description

Gets the list of Blocks associated with a Oubliette.

Parametersosid.id.IdoublietteId Id of the Oubliette
Returnosid.hold.BlockListlist of related blocks
ErrorsNOT_FOUND oublietteId is not found
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlockIdsByOubliettes
Description

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

Parametersosid.id.IdListoublietteIdslist of oubliette Ids
Returnosid.id.IdListlist of block Ids
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlocksByOubliettes
Description

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

Parametersosid.id.IdListoublietteIdslist of oubliette Ids
Returnosid.hold.BlockListlist of blocks
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOublietteIdsByBlock
Description

Gets the Oubliette Ids mapped to a Block.

Parametersosid.id.IdblockId Id of a Block
Returnosid.id.IdListlist of oubliettes
ErrorsNOT_FOUND blockId is not found
NULL_ARGUMENT blockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByBlock
Description

Gets the Oubliettes mapped to a Block.

Parametersosid.id.IdblockId Id of a Block
Returnosid.hold.OublietteListlist of oubliettes
ErrorsNOT_FOUND blockId is not found
NULL_ARGUMENT blockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.