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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchRepositories()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. RepositoryQuery getRepositoryQuery()
mandatory
- This method must be implemented. RepositoryList getRepositoriesByQuery(RepositoryQuery repositoryQuery) throws OperationFailedException, PermissionDeniedException
Repositories
matching the given
repository query.repositoryQuery
- the repository query RepositoryList
NullArgumentException
- repositoryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- repositoryQuery
is not of this servicemandatory
- This method must be implemented.