OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.BinQuerySession
Implementsosid.OsidSession
Implemented Byosid.resource.BinSearchSession
Used Byosid.resource.ResourceManager
osid.resource.ResourceProxyManager
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
Compliancemandatory This method must be implemented.
MethodgetBinQuery
Description

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

Returnosid.resource.BinQuery the bin query
Compliancemandatory This method must be implemented.
MethodgetBinsByQuery
Description

Gets a list of Bins matching the given bin query.

Parametersosid.resource.BinQuerybinQuery the bin query
Returnosid.resource.BinList the returned BinList
ErrorsNULL_ARGUMENT binQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED a binQuery is not of this service
Compliancemandatory This method must be implemented.