OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.CatalogQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Catalog objects. The search query is constructed using the CatalogQuery. The catalog record Type also specifies the record for the catalog query.

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

MethodcanSearchCatalogs
Description

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

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

Returnosid.cataloging.CatalogQuerythe catalog query
CompliancemandatoryThis method must be implemented.
MethodgetCatalogsByQuery
Description

Gets a list of Catalogs matching the given catalog query.

Parametersosid.cataloging.CatalogQuerycatalogQuerythe catalog query
Returnosid.cataloging.CatalogListthe returned CatalogList
ErrorsNULL_ARGUMENT catalogQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED catalogQuery is not of this service
CompliancemandatoryThis method must be implemented.