public interface AntimatroidQuerySession extends OsidSession
This session provides methods for searching among Antimatroid
objects. The search query is constructed using the
AntimatroidQuery.
Antimatroids may have a query record indicated by their respective
record types. The query record is accessed via the
AntimatroidQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAntimatroids()
Tests if this user can perform
Antimatroid searches. |
AntimatroidQuery |
getAntimatroidQuery()
Gets an antimatroid query.
|
AntimatroidList |
getAntimatroidsByQuery(AntimatroidQuery antimatroidQuery)
Gets a list of
Antimatroids matching the given
antimatroid query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchAntimatroids()
Antimatroid
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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. AntimatroidQuery getAntimatroidQuery()
mandatory
- This method must be implemented. AntimatroidList getAntimatroidsByQuery(AntimatroidQuery antimatroidQuery) throws OperationFailedException, PermissionDeniedException
Antimatroids
matching the given
antimatroid query.antimatroidQuery
- the antimatroid query AntimatroidList
NullArgumentException
- antimatroidQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- antimatroidQuery
is not of this servicemandatory
- This method must be implemented.