OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinQuerySession
Implementsosid.OsidSession
Description

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

Bins may have a bin query record indicated by their respective record types. The bin query record is accessed via the BinQuery.

MethodcanSearchBins
Description

Tests if this user can perform Bin 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 opt not to offer search operations to unauthorized users.

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

Gets a bin query. The returned query will not have an extension query.

Returnosid.resource.BinQuerythe bin query
CompliancemandatoryThis method must be implemented.
MethodgetBinsByQuery
Description

Gets a list of Bins matching the given bin query.

Parametersosid.resource.BinQuerybinQuerythe bin query
Returnosid.resource.BinListthe returned BinList
ErrorsNULL_ARGUMENT binQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDa binQuery is not of this service
CompliancemandatoryThis method must be implemented.