Interface ForumHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ForumHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of forums. Forums may be organized into a hierarchy for organizing or federating. A parent Forum includes all of the replies of its children such that a single root node contains all of the replies of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildForum(Id forumId, Id childId)	Adds a child to a forum.
void	addRootForum(Id forumId)	Adds a root forum.
boolean	canModifyForumHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getForumHierarchy()	Gets the hierarchy associated with this session.
Id	getForumHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildForum(Id forumId, Id childId)	Removes a child from a forum.
void	removeChildForums(Id forumId)	Removes all children from a forum.
void	removeRootForum(Id forumId)	Removes a root forum.

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.

canModifyForumHierarchy

boolean canModifyForumHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootForum

void addRootForum(Id forumId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root forum.

Parameters:

forumId - the Id of a forum

Throws:

AlreadyExistsException - forumId is already in hierarchy

NotFoundException - forumId is not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootForum

void removeRootForum(Id forumId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root forum.

Parameters:

forumId - the Id of a forum

Throws:

NotFoundException - forumId is not a root

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildForum

void addChildForum(Id forumId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a forum.

Parameters:

forumId - the Id of a forum

childId - the Id of the new child

Throws:

AlreadyExistsException - forumId is already a parent of childId

NotFoundException - forumId or childId not found

NullArgumentException - forumId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildForum

void removeChildForum(Id forumId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a forum.

Parameters:

forumId - the Id of a forum

childId - the Id of the new child

Throws:

NotFoundException - forumId not a parent of childId

NullArgumentException - forumId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildForums

void removeChildForums(Id forumId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a forum.

Parameters:

forumId - the Id of a forum

Throws:

NotFoundException - forumId not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.