OSID Specifications
forum package
Version 3.0.0
forum package
Version 3.0.0
| Interface | osid.forum.ForumHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.forum.ForumManager | ||
osid.forum.ForumProxyManager | |||
| Description |
This session manages a hierarchy of forums. Forums may be
organized into a hierarchy for organizing or federating. A
parent | ||
| Method | getForumHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getForumHierarchy | ||
| Description |
Gets the hierarchy associated with this session. | ||
| Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyForumHierarchy | ||
| Description |
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 | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootForum | ||
| Description |
Adds a root forum. | ||
| Parameters | osid.id.Id | forumId | the Id of a forum |
| Errors | ALREADY_EXISTS | forumId is already in hierarchy | |
| NOT_FOUND | forumId is not found | ||
| NULL_ARGUMENT | forumId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootForum | ||
| Description |
Removes a root forum. | ||
| Parameters | osid.id.Id | forumId | the Id of a forum |
| Errors | NOT_FOUND | forumId is not a root | |
| NULL_ARGUMENT | forumId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildForum | ||
| Description |
Adds a child to a forum. | ||
| Parameters | osid.id.Id | forumId | the Id of a forum |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | forumId is already a parent of childId | |
| NOT_FOUND | forumId or childId not found | ||
| NULL_ARGUMENT | forumId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildForum | ||
| Description |
Removes a child from a forum. | ||
| Parameters | osid.id.Id | forumId | the Id of a forum |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | forumId not a parent of childId | |
| NULL_ARGUMENT | forumId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildForums | ||
| Description |
Removes all children from a forum. | ||
| Parameters | osid.id.Id | forumId | the Id of a forum |
| Errors | NOT_FOUND | forumId not found | |
| NULL_ARGUMENT | forumId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |