public interface EntrySmartBlogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An EntryQuery
can be retrieved from this session
and mapped to this Blog
to create a virtual collection of
Entries.
The entries may be sequenced using the
EntrySearchOrder
from this session.
This Blog
has a default query that matches any entry
and a default search order that specifies no sequencing. The queries may
be examined using an EntryQueryInspector.
The query may be
modified by converting the inspector back to an EntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyEntryQuery(EntryQuery entryQuery)
Applies an entry query to this blog.
|
void |
applyEntrySequencing(EntrySearchOrder entrySearchOrder)
Applies an entry search order to this blog.
|
boolean |
canManageSmartBlogs()
Tests if this user can manage smart blogs.
|
Blog |
getBlog()
Gets the
Blog associated with this session. |
Id |
getBlogId()
Gets the
Blog Id associated with this
session. |
EntryQuery |
getEntryQuery()
Gets an entry query.
|
EntryQuery |
getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
Gets an entry query from an inspector.
|
EntrySearchOrder |
getEntrySearchOrder()
Gets an entry search order.
|
EntryQueryInspector |
inspectEntryQuery()
Gets an entry query inspector for this blog.
|
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 canManageSmartBlogs()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer smart operations. false
if smart blog methods are not authorized,
true
otherwisemandatory
- This method must be implemented. EntryQuery getEntryQuery()
mandatory
- This method must be implemented. EntrySearchOrder getEntrySearchOrder()
mandatory
- This method must be implemented. void applyEntryQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
entryQuery
- the entry queryNullArgumentException
- entryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- entryQuery
not of
this servicemandatory
- This method must be implemented. EntryQueryInspector inspectEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyEntrySequencing(EntrySearchOrder entrySearchOrder) throws OperationFailedException, PermissionDeniedException
entrySearchOrder
- the entry search orderNullArgumentException
- entrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- entrySearchOrder
not of this servicemandatory
- This method must be implemented. EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
entryQueryInspector
- a query inspectorNullArgumentException
- entryQueryInspector
is null
UnsupportedException
- entryQueryInspector
is not of this servicemandatory
- This method must be implemented.