Interface EntryBlogSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupEntryBlogMappings

boolean canLookupEntryBlogMappings()

Tests if this user can perform lookups of entry/blog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBlogView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBlogView

void usePlenaryBlogView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getEntryIdsByBlog

IdList getEntryIdsByBlog(Id blogId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Entry Ids associated with a Blog.

Parameters:

blogId - Id of a Blog

Returns:

list of related entry Ids

Throws:

NotFoundException - blogId is not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByBlog

EntryList getEntriesByBlog(Id blogId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Entries associated with a Blog.

Parameters:

blogId - Id of a Blog

Returns:

list of related entries

Throws:

NotFoundException - blogId is not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntryIdsByBlogs

IdList getEntryIdsByBlogs(IdList blogIds)
                   throws OperationFailedException,
PermissionDeniedException

Gets the list of Entry Ids corresponding to a list of Blog objects.

Parameters:

blogIds - list of blog Ids

Returns:

list of entry Ids

Throws:

NullArgumentException - blogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByBlogs

EntryList getEntriesByBlogs(IdList blogIds)
                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Entries corresponding to a list of Blogs.

Parameters:

blogIds - list of blog Ids

Returns:

list of entries

Throws:

NullArgumentException - blogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlogIdsByEntry

IdList getBlogIdsByEntry(Id entryId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Blog Ids mapped to a Entry.

Parameters:

entryId - Id of an Entry

Returns:

list of blog Ids

Throws:

NotFoundException - entryId is not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlogsByEntry

BlogList getBlogsByEntry(Id entryId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Blog objects mapped to an Entry.

Parameters:

entryId - Id of an Entry

Returns:

list of blogs

Throws:

NotFoundException - entryId is not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.