Interface CommentBookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CommentBookSession
extends OsidSession

This session provides methods to retrieve Comment to Book mappings. A Comment may appear in multiple Books . Each Book 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	canLookupCommentBookMappings()	Tests if this user can perform lookups of comment/book mappings.
IdList	getBookIdsByComment(Id commentId)	Gets the list of Book Ids mapped to a Comment .
BookList	getBooksByComment(Id commentId)	Gets the list of Book objects mapped to a Comment .
IdList	getCommentIdsByBook(Id bookId)	Gets the list of Comment Ids associated with a Book .
IdList	getCommentIdsByBooks(IdList bookIds)	Gets the list of Comment Ids corresponding to a list of Book objects.
CommentList	getCommentsByBook(Id bookId)	Gets the list of Comments associated with a Book .
CommentList	getCommentsByBooks(IdList bookIds)	Gets the list of Comments corresponding to a list of Books .
void	useComparativeBookView()	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	usePlenaryBookView()	A complete view of the Comment and Book 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

canLookupCommentBookMappings

boolean canLookupCommentBookMappings()

Tests if this user can perform lookups of comment/book 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 intendedas 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.

useComparativeBookView

void useComparativeBookView()

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.

usePlenaryBookView

void usePlenaryBookView()

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

getCommentIdsByBook

IdList getCommentIdsByBook(Id bookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Comment Ids associated with a Book .

Parameters:

bookId - Id of a Book .

Returns:

list of related comment Ids

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommentsByBook

CommentList getCommentsByBook(Id bookId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Comments associated with a Book .

Parameters:

bookId - Id of a Book

Returns:

list of related comments

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommentIdsByBooks

IdList getCommentIdsByBooks(IdList bookIds)
                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Comment Ids corresponding to a list of Book objects.

Parameters:

bookIds - list of book Ids

Returns:

list of comment Ids

Throws:

NullArgumentException - bookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommentsByBooks

CommentList getCommentsByBooks(IdList bookIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Comments corresponding to a list of Books .

Parameters:

bookIds - list of book Ids

Returns:

list of comments

Throws:

NullArgumentException - bookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBookIdsByComment

IdList getBookIdsByComment(Id commentId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Book Ids mapped to a Comment .

Parameters:

commentId - Id of a Comment

Returns:

list of book Ids

Throws:

NotFoundException - commentId is not found

NullArgumentException - commentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBooksByComment

BookList getBooksByComment(Id commentId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Book objects mapped to a Comment .

Parameters:

commentId - Id of a Comment

Returns:

list of books

Throws:

NotFoundException - commentId is not found

NullArgumentException - commentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.