org.osid.repository

Interface RepositoryQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

RepositorySearchSession

public interface RepositoryQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchRepositories() Tests if this user can perform Repository searches.
RepositoryList	getRepositoriesByQuery(RepositoryQuery repositoryQuery) Gets a list of Repositories matching the given repository query.
RepositoryQuery	getRepositoryQuery() Gets a repository 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

canSearchRepositories

boolean canSearchRepositories()

Tests if this user can perform Repository 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.

getRepositoryQuery

RepositoryQuery getRepositoryQuery()

Gets a repository query.

Returns:

the repository query

Compliance:

mandatory - This method must be implemented.

getRepositoriesByQuery

RepositoryList getRepositoriesByQuery(RepositoryQuery repositoryQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a list of Repositories matching the given repository query.

Parameters:

repositoryQuery - the repository query

Returns:

the returned RepositoryList

Throws:

NullArgumentException - repositoryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - repositoryQuery is not of this service

Compliance:

mandatory - This method must be implemented.