OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CatalogueQuerySession
Implementsosid.OsidSession
Description

This session provides methods for querying Catalogue objects. The search query is constructed using the CatalogueQuery.

Catalogues may have a query record indicated by their respective record types. The query record is accessed via the CatalogueQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchCatalogues
Description

Tests if this user can perform Catalogue 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.
MethodgetCatalogueQuery
Description

Gets a catalogue query.

Returnosid.offering.CatalogueQuerythe catalogue query
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesByQuery
Description

Gets a list of Catalogues matching the given search.

Parametersosid.offering.CatalogueQuerycatalogueQuerythe catalogue query
Returnosid.offering.CatalogueListthe returned CatalogueList
ErrorsNULL_ARGUMENT catalogueQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED catalogueQuery is not of this service
CompliancemandatoryThis method must be implemented.