org.osid.forum

Interface PostForumSession

All Superinterfaces:

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

public interface PostForumSession
extends OsidSession

This session provides methods to retrieve Post to Forum mappings. A Post may appear in multiple Forums. Each Forum 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

Methods

Modifier and Type	Method and Description
boolean	canLookupPostForumMappings() Tests if this user can perform lookups of post/forum mappings.
IdList	getForumIdsByPost(Id postId) Gets the list of Forum Ids mapped to a Post.
ForumList	getForumsByPost(Id postId) Gets the list of Forum objects mapped to a Post.
IdList	getPostIdsByForum(Id forumId) Gets the list of Post Ids associated with a Forum.
IdList	getPostIdsByForums(IdList forumIds) Gets the list of Post Ids corresponding to a list of Forum objects.
PostList	getPostsByForum(Id forumId) Gets the list of Posts associated with a Forum.
PostList	getPostsByForums(IdList forumIds) Gets the list of Posts corresponding to a list of Forums.
void	useComparativeForumView() 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	usePlenaryForumView() A complete view of the Post and Forum 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

canLookupPostForumMappings

boolean canLookupPostForumMappings()

Tests if this user can perform lookups of post/forum 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.

useComparativeForumView

void useComparativeForumView()

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.

usePlenaryForumView

void usePlenaryForumView()

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

getPostIdsByForum

IdList getPostIdsByForum(Id forumId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Post Ids associated with a Forum.

Parameters:

forumId - Id of a Forum.

Returns:

list of related post Ids

Throws:

NotFoundException - forumId is not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostsByForum

PostList getPostsByForum(Id forumId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Posts associated with a Forum.

Parameters:

forumId - Id of a Forum

Returns:

list of related posts

Throws:

NotFoundException - forumId is not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostIdsByForums

IdList getPostIdsByForums(IdList forumIds)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets the list of Post Ids corresponding to a list of Forum objects.

Parameters:

forumIds - list of forum Ids

Returns:

list of post Ids

Throws:

NullArgumentException - forumIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostsByForums

PostList getPostsByForums(IdList forumIds)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets the list of Posts corresponding to a list of Forums.

Parameters:

forumIds - list of forum Ids

Returns:

list of posts

Throws:

NullArgumentException - forumIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getForumIdsByPost

IdList getForumIdsByPost(Id postId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Forum Ids mapped to a Post.

Parameters:

postId - Id of a Post

Returns:

list of forum Ids

Throws:

NotFoundException - postId is not found

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getForumsByPost

ForumList getForumsByPost(Id postId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets the list of Forum objects mapped to a Post.

Parameters:

postId - Id of a Post

Returns:

list of forums

Throws:

NotFoundException - postId is not found

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.