Interface | osid.blogging.BlogHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for managing a hierarchy of
| ||
Method | getBlogHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlogHierarchy | ||
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 | canModifyBlogHierarchy | ||
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 | addRootBlog | ||
Description |
Adds a root blog. | ||
Parameters | osid.id.Id | blogId | the Id of a blog |
Errors | ALREADY_EXISTS | blogId is already in hierarchy | |
NOT_FOUND | blogId not found | ||
NULL_ARGUMENT | blogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootBlog | ||
Description |
Remove a root blog. | ||
Parameters | osid.id.Id | blogId | the Id of a blog |
Errors | NOT_FOUND | blogId is not a root | |
NULL_ARGUMENT | blogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildBlog | ||
Description |
Adds a child to a blog. | ||
Parameters | osid.id.Id | blogId | the Id of a blog |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | blogId is already a parent of childId | |
NOT_FOUND | blogId or childId not found | ||
NULL_ARGUMENT | blogId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildBlog | ||
Description |
Removes a child from a blog. | ||
Parameters | osid.id.Id | blogId | the Id of a blog |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | blogId not a parent of childId | |
NULL_ARGUMENT | blogId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildBlogs | ||
Description |
Removes all children from a blog. | ||
Parameters | osid.id.Id | blogId | the Id of a blog |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | blogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |