org.osid.commenting

Interface BookLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BookLookupSession
extends OsidSession

This session provides methods for retrieving Book objects. The Book represents a collection of comments.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupBooks() Tests if this user can perform Book lookups.
Book	getBook(Id bookId) Gets the Book specified by its Id.
BookList	getBooks() Gets all Books.
BookList	getBooksByGenusType(Type bookGenusType) Gets a BookList corresponding to the given book genus Type which does not include books of genus types derived from the specified Type.
BookList	getBooksByIds(IdList bookIds) Gets a BookList corresponding to the given IdList.
BookList	getBooksByParentGenusType(Type bookGenusType) Gets a BookList corresponding to the given book genus Type and include any additional books with genus types derived from the specified Type.
BookList	getBooksByProvider(Id resourceId) Gets a BookList from the given provider .
BookList	getBooksByRecordType(Type bookRecordType) Gets a BookList containing the given book record Type.
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 Book returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupBooks

boolean canLookupBooks()

Tests if this user can perform Book 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 not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are 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 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.

getBook

Book getBook(Id bookId)
             throws NotFoundException,
                    OperationFailedException,
                    PermissionDeniedException

Gets the Book specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Book may have a different Id than requested, such as the case where a duplicate Id was assigned to a Book and retained for compatibility.

Parameters:

bookId - Id of the Book

Returns:

the book

Throws:

NotFoundException - bookId not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getBooksByIds

BookList getBooksByIds(IdList bookIds)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets a BookList corresponding to the given IdList. In plenary mode, the returned list contains all of the books 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 Books may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

bookIds - the list of Ids to retrieve

Returns:

the returned Book list

Throws:

NotFoundException - an Id was not found

NullArgumentException - bookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBooksByGenusType

BookList getBooksByGenusType(Type bookGenusType)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a BookList corresponding to the given book genus Type which does not include books of genus types derived from the specified Type. In plenary mode, the returned list contains all known books or an error results. Otherwise, the returned list may contain only those books that are accessible through this session.

Parameters:

bookGenusType - a book genus type

Returns:

the returned Book list

Throws:

NullArgumentException - bookGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBooksByParentGenusType

BookList getBooksByParentGenusType(Type bookGenusType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a BookList corresponding to the given book genus Type and include any additional books with genus types derived from the specified Type. In plenary mode, the returned list contains all known books or an error results. Otherwise, the returned list may contain only those books that are accessible through this session.

Parameters:

bookGenusType - a book genus type

Returns:

the returned Book list

Throws:

NullArgumentException - bookGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBooksByRecordType

BookList getBooksByRecordType(Type bookRecordType)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets a BookList containing the given book record Type. In plenary mode, the returned list contains all known books or an error results. Otherwise, the returned list may contain only those books that are accessible through this session.

Parameters:

bookRecordType - a book record type

Returns:

the returned Book list

Throws:

NullArgumentException - bookRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBooksByProvider

BookList getBooksByProvider(Id resourceId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets a BookList from the given provider . In plenary mode, the returned list contains all known books or an error results. Otherwise, the returned list may contain only those books that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Book list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBooks

BookList getBooks()
                  throws OperationFailedException,
                         PermissionDeniedException

Gets all Books. In plenary mode, the returned list contains all known books or an error results. Otherwise, the returned list may contain only those books that are accessible through this session.

Returns:

a list of Books

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.