public interface EntryBlogSession extends OsidSession
This session provides methods to retrieve Entry
to
Blog
mappings. An Entry
may appear in
multiple Blogs.
Each Blog
may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEntryBlogMappings()
Tests if this user can perform lookups of entry/blog mappings.
|
IdList |
getBlogIdsByEntry(Id entryId)
Gets the list of
Blog Ids mapped to a
Entry. |
BlogList |
getBlogsByEntry(Id entryId)
Gets the list of
Blog objects mapped to an
Entry. |
EntryList |
getEntriesByBlog(Id blogId)
Gets the list of
Entries associated with a Blog. |
EntryList |
getEntriesByBlogs(IdList blogIds)
Gets the list of
Entries corresponding to a list of
Blogs. |
IdList |
getEntryIdsByBlog(Id blogId)
Gets the list of
Entry Ids associated
with a Blog. |
IdList |
getEntryIdsByBlogs(IdList blogIds)
Gets the list of
Entry Ids corresponding to a list of
Blog objects. |
void |
useComparativeBlogView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryBlogView()
A complete view of the
Entry and Blog
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupEntryBlogMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBlogView()
mandatory
- This method is must be implemented. void usePlenaryBlogView()
Entry
and Blog
returns is desired. Methods will return what is requested or result in
an error. This view is used when greater precision is desired at the
expense of interoperability.mandatory
- This method is must be implemented. IdList getEntryIdsByBlog(Id blogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entry
Ids
associated
with a Blog.
blogId
- Id
of a Blog
Ids
NotFoundException
- blogId
is not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryList getEntriesByBlog(Id blogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entries
associated with a Blog.
blogId
- Id
of a Blog
NotFoundException
- blogId
is not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEntryIdsByBlogs(IdList blogIds) throws OperationFailedException, PermissionDeniedException
Entry Ids
corresponding to a list of
Blog
objects.blogIds
- list of blog Ids
Ids
NullArgumentException
- blogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryList getEntriesByBlogs(IdList blogIds) throws OperationFailedException, PermissionDeniedException
Entries
corresponding to a list of
Blogs.
blogIds
- list of blog Ids
NullArgumentException
- blogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBlogIdsByEntry(Id entryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Blog
Ids
mapped to a
Entry.
entryId
- Id
of an Entry
Ids
NotFoundException
- entryId
is not foundNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogList getBlogsByEntry(Id entryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Blog
objects mapped to an
Entry.
entryId
- Id
of an Entry
NotFoundException
- entryId
is not foundNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.