Interface | osid.hold.BlockOublietteSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupBlockOublietteMappings | ||
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 | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBlockOublietteView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryBlockOublietteView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBlockIdsByOubliette | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | oublietteId | Id of the Oubliette |
Return | osid.id.IdList | list of related block Ids | |
Errors | NOT_FOUND | oublietteId is not found | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlocksByOubliette | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | oublietteId | Id of the Oubliette |
Return | osid.hold.BlockList | list of related blocks | |
Errors | NOT_FOUND | oublietteId is not found | |
NULL_ARGUMENT | oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlockIdsByOubliettes | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | oublietteIds | list of oubliette Ids |
Return | osid.id.IdList | list of block Ids | |
Errors | NULL_ARGUMENT | oublietteIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlocksByOubliettes | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | oublietteIds | list of oubliette Ids |
Return | osid.hold.BlockList | list of blocks | |
Errors | NULL_ARGUMENT | oublietteIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOublietteIdsByBlock | ||
Description |
Gets the | ||
Parameters | osid.id.Id | blockId | Id of a Block |
Return | osid.id.IdList | list of oubliettes | |
Errors | NOT_FOUND | blockId is not found | |
NULL_ARGUMENT | blockId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOubliettesByBlock | ||
Description |
Gets the | ||
Parameters | osid.id.Id | blockId | Id of a Block |
Return | osid.hold.OublietteList | list of oubliettes | |
Errors | NOT_FOUND | blockId is not found | |
NULL_ARGUMENT | blockId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |