public interface EntryQuerySession extends OsidSession
This session provides methods for searching among entries. The search
query is constructed using the EntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchEntries()
Tests if this user can perform dictionary entry searches.
|
Dictionary |
getDictionary()
Gets the
Dictionary associated with this session. |
Id |
getDictionaryId()
Gets the
Dictionary Id associated with
this session. |
EntryList |
getEntriesByQuery(EntryQuery entryQuery)
Gets a list of
Entry elements matching the given
search. |
EntryQuery |
getEntryQuery()
Gets an entry query.
|
void |
useFederatedDictionaryView()
Federates the view for methods in this session.
|
void |
useIsolatedDictionaryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDictionaryId()
Dictionary
Id
associated with
this session. Dictionary
Id
associated
with this sessionmandatory
- This method must be implemented. Dictionary getDictionary() throws OperationFailedException, PermissionDeniedException
Dictionary
associated with this session. Dictionary
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchEntries()
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. void useFederatedDictionaryView()
mandatory
- This method is must be implemented. void useIsolatedDictionaryView()
mandatory
- This method is must be implemented. EntryQuery getEntryQuery()
mandatory
- This method must be implemented. EntryList getEntriesByQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
Entry
elements matching the given
search.entryQuery
- the entry query EntryList
NullArgumentException
- entryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- entryQuery
is not
of this servicemandatory
- This method must be implemented.