public interface EntryQuerySession extends OsidSession
This session provides methods for querying Entry
objects. The search query is constructed using the EntryQuery.
This session defines views that offer differing behaviors for searching.
Entries may have a query record indicated by their respective types.
The query record is accessed via the EntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchEntries()
Tests if this user can perform
Entry queries. |
Blog |
getBlog()
Gets the
Blog associated with this session. |
Id |
getBlogId()
Gets the
Blog Id associated with this
session. |
EntryList |
getEntriesByQuery(EntryQuery entryQuery)
Gets a list of
Entries matching the given search. |
EntryQuery |
getEntryQuery()
Gets an entry query.
|
void |
useFederatedBlogView()
Federates the view for methods in this session.
|
void |
useIsolatedBlogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBlogId()
Blog
Id
associated with this
session. Blog Id
associated with this sessionmandatory
- This method must be implemented. Blog getBlog() throws OperationFailedException, PermissionDeniedException
Blog
associated with this session. Blog
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchEntries()
Entry
queries. 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. void useFederatedBlogView()
mandatory
- This method is must be implemented. void useIsolatedBlogView()
mandatory
- This method is must be implemented. EntryQuery getEntryQuery()
mandatory
- This method must be implemented. EntryList getEntriesByQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
Entries
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.