Interface ForumHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ForumHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Forums . Each node in the hierarchy is a unique Forum . The hierarchy may be traversed recursively to establish the tree structure through getParentForums() and getChildForums() . To relate these Ids to another OSID, getForumNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Forum available in the Reply OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentForums() or getChildForums() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessForumHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildForumIds(Id forumId)	Gets the child Ids of the given forum.
ForumList	getChildForums(Id forumId)	Gets the child forums of the given id .
Hierarchy	getForumHierarchy()	Gets the hierarchy associated with this session.
Id	getForumHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getForumNodeIds(Id forumId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given forum.
ForumNode	getForumNodes(Id forumId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given forum.
IdList	getParentForumIds(Id forumId)	Gets the parent Ids of the given forum.
ForumList	getParentForums(Id forumId)	Gets the parent forums of the given id .
IdList	getRootForumIds()	Gets the root forum Ids in this hierarchy.
ForumList	getRootForums()	Gets the root forums in the forum hierarchy.
boolean	hasChildForums(Id forumId)	Tests if a forum has any children.
boolean	hasParentForums(Id forumId)	Tests if the Forum has any parents.
boolean	isAncestorOfForum(Id id, Id forumId)	Tests if an Id is an ancestor of a forum.
boolean	isChildOfForum(Id id, Id forumId)	Tests if a forum is a direct child of another.
boolean	isDescendantOfForum(Id id, Id forumId)	Tests if an Id is a descendant of a forum.
boolean	isParentOfForum(Id id, Id forumId)	Tests if an Id is a direct parent of forum.
void	useComparativeForumView()	The returns from the forum 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 Forum 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

getForumHierarchyId

Id getForumHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getForumHierarchy

Hierarchy getForumHierarchy()
                     throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessForumHierarchy

boolean canAccessForumHierarchy()

Tests if this user can perform hierarchy queries. 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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeForumView

void useComparativeForumView()

The returns from the forum 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 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.

getRootForumIds

IdList getRootForumIds()
                throws OperationFailedException,
PermissionDeniedException

Gets the root forum Ids in this hierarchy.

Returns:

the root forum Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootForums

ForumList getRootForums()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root forums in the forum hierarchy. A node with no parents is an orphan. While all forum Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root forums

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentForums

boolean hasParentForums(Id forumId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Forum has any parents.

Parameters:

forumId - a forum Id

Returns:

true if the forum has parents, f alse otherwise

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.

isParentOfForum

boolean isParentOfForum(Id id,
 Id forumId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of forum.

Parameters:

id - an Id

forumId - the Id of a forum

Returns:

true if this id is a parent of forumId , f alse otherwise

Throws:

NotFoundException - forumId is not found

NullArgumentException - id or forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentForumIds

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

Gets the parent Ids of the given forum.

Parameters:

forumId - a forum Id

Returns:

the parent Ids of the forum

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.

getParentForums

ForumList getParentForums(Id forumId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent forums of the given id .

Parameters:

forumId - the Id of the Forum to query

Returns:

the parent forums of the id

Throws:

NotFoundException - a Forum identified by Id is not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfForum

boolean isAncestorOfForum(Id id,
 Id forumId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a forum.

Parameters:

id - an Id

forumId - the Id of a forum

Returns:

true if this id is an ancestor of forumId , false otherwise

Throws:

NotFoundException - forumId is not found

NullArgumentException - id or forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildForums

boolean hasChildForums(Id forumId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a forum has any children.

Parameters:

forumId - a forum Id

Returns:

true if the forumId has children, false otherwise

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.

isChildOfForum

boolean isChildOfForum(Id id,
 Id forumId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a forum is a direct child of another.

Parameters:

id - an Id

forumId - the Id of a forum

Returns:

true if the id is a child of forumId , false otherwise

Throws:

NotFoundException - forumId is not found

NullArgumentException - id or forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildForumIds

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

Gets the child Ids of the given forum.

Parameters:

forumId - the Id to query

Returns:

the children of the forum

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.

getChildForums

ForumList getChildForums(Id forumId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child forums of the given id .

Parameters:

forumId - the Id of the Forum to query

Returns:

the child forums of the id

Throws:

NotFoundException - a Forum identified by Id is not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfForum

boolean isDescendantOfForum(Id id,
 Id forumId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a forum.

Parameters:

id - an Id

forumId - the Id of a forum

Returns:

true if the id is a descendant of the forumId , false otherwise

Throws:

NotFoundException - forumId is not found

NullArgumentException - id or forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getForumNodeIds

Node getForumNodeIds(Id forumId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given forum.

Parameters:

forumId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a forum node

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.

getForumNodes

ForumNode getForumNodes(Id forumId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given forum.

Parameters:

forumId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a forum node

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.