public interface CatalogueQuerySession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCatalogues()
Tests if this user can perform
Catalogue searches. |
CatalogueQuery |
getCatalogueQuery()
Gets a catalogue query.
|
CatalogueList |
getCataloguesByQuery(CatalogueQuery catalogueQuery)
Gets a list of
Catalogues matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchCatalogues()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. CatalogueQuery getCatalogueQuery()
mandatory
- This method must be implemented. CatalogueList getCataloguesByQuery(CatalogueQuery catalogueQuery) throws OperationFailedException, PermissionDeniedException
Catalogues
matching the given search.catalogueQuery
- the catalogue query CatalogueList
NullArgumentException
- catalogueQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- catalogueQuery
is
not of this servicemandatory
- This method must be implemented.