Interface | osid.forum.PostForumAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignPosts | ||
Description |
Tests if this user can alter post/forum mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignPostsToForum | ||
Description |
Tests if this user can alter post/forum mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | forumId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableForumIds | ||
Description |
Gets a list of forums including and under the given forum node in which any post can be assigned. | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
Return | osid.id.IdList | list of assignable forum Ids | |
Errors | NULL_ARGUMENT | forumId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableForumIdsForPost | ||
Description |
Gets a list of forums including and under the given forum node in which a specific post can be assigned. | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.id.Id | postId | the Id of the Post | |
Return | osid.id.IdList | list of assignable forum Ids | |
Errors | NULL_ARGUMENT | forumId or postId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPostToForum | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | postId | the Id of the Post |
osid.id.Id | forumId | the Id of the Forum | |
Errors | ALREADY_EXISTS | postId is already assigned to forumId | |
NOT_FOUND | postId or forumId not found | ||
NULL_ARGUMENT | postId or forumId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPostFromForum | ||
Description |
Removes a | ||
Parameters | osid.id.Id | postId | the Id of the Post |
osid.id.Id | forumId | the Id of the Forum | |
Errors | NOT_FOUND | postId or forumId not found or postId
not assigned to forumId | |
NULL_ARGUMENT | postId or forumId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignPostToForum | ||
Description |
Moves a | ||
Parameters | osid.id.Id | postId | the Id of the Post |
osid.id.Id | fromPostId | the Id of the current Forum | |
osid.id.Id | toPostId | the Id of the destination Forum | |
Errors | NOT_FOUND | postId, fromForumId, or toForumId not found
or postId not mapped to fromForumId | |
NULL_ARGUMENT | postId, fromForumId, or toForumId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |