OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.OublietteQuerySession
Implementsosid.OsidSession
Implemented Byosid.hold.OublietteSearchSession
Used Byosid.hold.HoldManager
osid.hold.HoldProxyManager
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
Compliancemandatory This method must be implemented.
MethodgetOublietteQuery
Description

Gets an oubliette query.

Returnosid.hold.OublietteQuery the oubliette query
Compliancemandatory This method must be implemented.
MethodgetOubliettesByQuery
Description

Gets a list of Oubliettes matching the given search.

Parametersosid.hold.OublietteQueryoublietteQuery the oubliette query
Returnosid.hold.OublietteList the returned OublietteList
ErrorsNULL_ARGUMENT oublietteQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED oublietteQuery is not of this service
Compliancemandatory This method must be implemented.