OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.BlogHierarchyDesignSession
Implementsosid.OsidSession
Description

This session defines methods for managing a hierarchy of Blog objects. Each node in the hierarchy is a unique Blog.

MethodgetBlogHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBlogHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyBlogHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootBlog
Description

Adds a root blog.

Parametersosid.id.IdblogIdthe Id of a blog
ErrorsALREADY_EXISTS blogId is already in hierarchy
NOT_FOUND blogId not found
NULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootBlog
Description

Remove a root blog.

Parametersosid.id.IdblogIdthe Id of a blog
ErrorsNOT_FOUND blogId is not a root
NULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildBlog
Description

Adds a child to a blog.

Parametersosid.id.IdblogIdthe Id of a blog
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS blogId is already a parent of childId
NOT_FOUND blogId or childId not found
NULL_ARGUMENT blogId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBlog
Description

Removes a child from a blog.

Parametersosid.id.IdblogIdthe Id of a blog
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND blogId not a parent of childId
NULL_ARGUMENT blogId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBlogs
Description

Removes all children from a blog.

Parametersosid.id.IdblogIdthe Id of a blog
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.