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

This session provides methods for retrieving Oubliette objects. The Oubliette represents a collection of holds and issues.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Oubliette it can access, without breaking execution. However, an assessment may only be useful if all Oubliette referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupOubliettes
Description

Tests if this user can perform Oubliette lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeOublietteView
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.
MethodusePlenaryOublietteView
Description

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

Gets the Oubliette specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Oubliette may have a different Id than requested, such as the case where a duplicate Id was assigned to a Oubliette and retained for compatibility.

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

Gets a OublietteList corresponding to the given IdList. In plenary mode, the returned list contains all of the oubliettes specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Oubliettes may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListoublietteIdsthe list of Ids to retrieve
Returnosid.hold.OublietteListthe returned Oubliette list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByGenusType
Description

Gets a OublietteList corresponding to the given oubliette genus Type which does not include oubliettes of types derived from the specified Type. In plenary mode, the returned list contains all known oubliettes or an error results. Otherwise, the returned list may contain only those oubliette that are accessible through this session.

Parametersosid.type.TypeoublietteGenusTypean oubliette genus type
Returnosid.hold.OublietteListthe returned Oubliette list
ErrorsNULL_ARGUMENT oublietteGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByParentGenusType
Description

Gets a OublietteList corresponding to the given oubliette genus Type and include any additional oubliettes with genus types derived from the specified Type. In plenary mode, the returned list contains all known oubliettes or an error results. Otherwise, the returned list may contain only those oubliettes that are accessible through this session.

Parametersosid.type.TypeoublietteGenusTypean oubliette genus type
Returnosid.hold.OublietteListthe returned Oubliette list
ErrorsNULL_ARGUMENT oublietteGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByRecordType
Description

Gets a OublietteList containing the given oubliette record Type. In plenary mode, the returned list contains all known oubliettes or an error results. Otherwise, the returned list may contain only those oubliettes that are accessible through this session.

Parametersosid.type.TypeoublietteRecordTypean oubliette record type
Returnosid.hold.OublietteListthe returned Oubliette list
ErrorsNULL_ARGUMENT oublietteRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByProvider
Description

Gets a OublietteList for the given provider . In plenary mode, the returned list contains all known oubliettes or an error results. Otherwise, the returned list may contain only those oubliettes that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.hold.OublietteListthe returned Oubliette list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOubliettes
Description

Gets all Oubliette In plenary mode, the returned list contains all known oubliettes or an error results. Otherwise, the returned list may contain only those oubliettes that are accessible through this session.

Returnosid.hold.OublietteLista list of Oubliettes
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.