public interface BlogLookupSession extends OsidSession
This session provides methods for retrieving Blog
objects. The Blog
represents a collection entries.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the Blogs
it can access, without breaking execution. However, an
administrative application may require all Blog
elements to
be available.
Blogs may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Blog.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBlogs()
Tests if this user can perform
Blog lookups. |
Blog |
getBlog(Id blogId)
Gets the
Blog specified by its Id. |
BlogList |
getBlogs()
Gets all
Blogs. |
BlogList |
getBlogsByGenusType(Type blogGenusType)
Gets a
Blog corresponding to the given blog genus
Type which does not include blogs of types derived from
the specified Type. |
BlogList |
getBlogsByIds(IdList blogIds)
Gets a
BlogList corresponding to the given
IdList. |
BlogList |
getBlogsByParentGenusType(Type blogGenusType)
Gets a
BlogList corresponding to the given psocess
genus Type and include any additional blogs with genus
types derived from the specified Type. |
BlogList |
getBlogsByProvider(Id resourceId)
Gets a
BlogList for the given provider. |
BlogList |
getBlogsByRecordType(Type blogRecordType)
Gets a
BlogList containing the given blog record
Type. |
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
Blog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBlogs()
Blog
lookups. 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 lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBlogView()
mandatory
- This method is must be implemented. void usePlenaryBlogView()
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. Blog getBlog(Id blogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Blog
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Blog
may have a different Id
than requested, such as the
case where a duplicate Id
was assigned to a Blog
and retained for compatibility.blogId
- Id
of the Blog
NotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. BlogList getBlogsByIds(IdList blogIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BlogList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
blogs specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible blogs may be omitted from the list and may present the
elements in any order including returning a unique set.blogIds
- the list of Ids
to retrieve Blog list
NotFoundException
- an Id was
not foundNullArgumentException
- blogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogList getBlogsByGenusType(Type blogGenusType) throws OperationFailedException, PermissionDeniedException
Blog
corresponding to the given blog genus
Type
which does not include blogs of types derived from
the specified Type.
In plenary mode, the returned list
contains all known blogs or an error results. Otherwise, the returned
list may contain only those blogs that are accessible through this
session.blogGenusType
- a blog genus type Blog
listNullArgumentException
- blogGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogList getBlogsByParentGenusType(Type blogGenusType) throws OperationFailedException, PermissionDeniedException
BlogList
corresponding to the given psocess
genus Type
and include any additional blogs with genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known blogs or an error results.
Otherwise, the returned list may contain only those blogs that are
accessible through this session.blogGenusType
- a blog genus type Blog
listNullArgumentException
- blogGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogList getBlogsByRecordType(Type blogRecordType) throws OperationFailedException, PermissionDeniedException
BlogList
containing the given blog record
Type.
In plenary mode, the returned list contains all known
blogs or an error results. Otherwise, the returned list may contain
only those blogs that are accessible through this session.blogRecordType
- a blog record type Blog
listNullArgumentException
- blogRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogList getBlogsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
BlogList
for the given provider. In plenary
mode, the returned list contains all known blogs or an error results.
Otherwise, the returned list may contain only those blogs that are
accessible through this session.resourceId
- a resourceId Id
Blog
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogList getBlogs() throws OperationFailedException, PermissionDeniedException
Blogs.
In plenary mode, the returned list
contains all known blogs or an error results. Otherwise, the returned
list may contain only those blogs that are accessible through this
session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.