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

This session provides methods for searching among Oubliette objects. The search query is constructed using the OublietteQuery.

Oubliettes may have a query record indicated by their respective record types. The query record is accessed via the OublietteQuery.

MethodcanSearchOubliettes
Description

Tests if this user can perform Oubliette searches. 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 not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOublietteQuery
Description

Gets an oubliette query.

Returnosid.hold.OublietteQuerythe oubliette query
CompliancemandatoryThis method must be implemented.
MethodgetOubliettesByQuery
Description

Gets a list of Oubliettes matching the given search.

Parametersosid.hold.OublietteQueryoublietteQuerythe oubliette query
Returnosid.hold.OublietteListthe returned OublietteList
ErrorsNULL_ARGUMENT oublietteQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED oublietteQuery is not of this service
CompliancemandatoryThis method must be implemented.