org.osid.cataloging

Interface CatalogQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

CatalogSearchSession

public interface CatalogQuerySession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchCatalogs() Tests if this user can perform Catalog searches.
CatalogQuery	getCatalogQuery() Gets a catalog query.
CatalogList	getCatalogsByQuery(CatalogQuery catalogQuery) Gets a list of Catalogs matching the given catalog query.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canSearchCatalogs

boolean canSearchCatalogs()

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.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogQuery

CatalogQuery getCatalogQuery()

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

Returns:

the catalog query

Compliance:

mandatory - This method must be implemented.

getCatalogsByQuery

CatalogList getCatalogsByQuery(CatalogQuery catalogQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of Catalogs matching the given catalog query.

Parameters:

catalogQuery - the catalog query

Returns:

the returned CatalogList

Throws:

NullArgumentException - catalogQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - catalogQuery is not of this service

Compliance:

mandatory - This method must be implemented.