public interface OublietteQuerySession extends OsidSession
This session provides methods for searching among Oubliette
objects. The search query is constructed using the
OublietteQuery.
Oubliettes may have a query record indicated by their respective
record types. The query record is accessed via the OublietteQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchOubliettes()
Tests if this user can perform
Oubliette searches. |
OublietteQuery |
getOublietteQuery()
Gets an oubliette query.
|
OublietteList |
getOubliettesByQuery(OublietteQuery oublietteQuery)
Gets a list of
Oubliettes matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchOubliettes()
Oubliette
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. OublietteQuery getOublietteQuery()
mandatory
- This method must be implemented. OublietteList getOubliettesByQuery(OublietteQuery oublietteQuery) throws OperationFailedException, PermissionDeniedException
Oubliettes
matching the given search.oublietteQuery
- the oubliette query OublietteList
NullArgumentException
- oublietteQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- oublietteQuery
is
not of this servicemandatory
- This method must be implemented.