OSID - osid.blogging.BlogHierarchySession Service Interface Definition

Interface	osid.blogging.BlogHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Blog` objects. Each node in the hierarchy is a unique `Blog.` The hierarchy may be traversed recursively to establish the tree structure through `getParentBlogs()` and `getChildBlogs().` To relate these `Ids` to another OSID, `getBlogNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Blog` available in the Blog OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node. A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of `getParentBlogs()` or `getChildBlogs()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized pathways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: blog elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getBlogHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
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
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessBlogHierarchy
Description	Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBlogView
Description	The returns from the blog methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBlogView
Description	A complete view of the `Blog` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootBlogIds
Description	Gets the root blog `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root blog `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootBlogs
Description	Gets the root blogs in the blog hierarchy. A node with no parents is an orphan. While all blog `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Return	`osid.blogging.BlogList`		the root blogs
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentBlogs
Description	Tests if the `Blog` has any parents.
Parameters	`osid.id.Id`	`blogId`	a blog `Id`
Return	`boolean`		`true` if the blog has parents, `false` otherwise
Errors	NOT_FOUND		`blogId` is 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	isParentOfBlog
Description	Tests if an `Id` is a direct parent of a blog.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`blogId`	a blog `Id`
Return	`boolean`		`true` if this `id` is a parent of `blogId,` `false` otherwise
Errors	NOT_FOUND		`blogId` is not found
	NULL_ARGUMENT		`id` or `blogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentBlogIds
Description	Gets the parent `Ids` of the given blog.
Parameters	`osid.id.Id`	`blogId`	a blog `Id`
Return	`osid.id.IdList`		the parent `Ids` of the blog
Errors	NOT_FOUND		`blogId` is 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	getParentBlogs
Description	Gets the parents of the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` to query
Return	`osid.blogging.BlogList`		the parents of the 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.
Method	isAncestorOfBlog
Description	Tests if an `Id` is an ancestor of a blog.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`blogId`	the `Id` of a blog
Return	`boolean`		`true` if this `id` is an ancestor of `blogId,` `false` otherwise
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.
Provider Notes	If `id` not found return `false.`
Method	hasChildBlogs
Description	Tests if a blog has any children.
Parameters	`osid.id.Id`	`blogId`	a `blogId`
Return	`boolean`		`true` if the `blogId` has children, `false` otherwise
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.
Method	isChildOfBlog
Description	Tests if a blog is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`blogId`	the `Id` of a blog
Return	`boolean`		`true` if the `id` is a child of `blogId,` `false` otherwise
Errors	NOT_FOUND		`blogId` not found
	NULL_ARGUMENT		`blogId` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildBlogIds
Description	Gets the child `Ids` of the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` to query
Return	`osid.id.IdList`		the children of the 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.
Method	getChildBlogs
Description	Gets the children of the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` to query
Return	`osid.blogging.BlogList`		the children of the 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.
Method	isDescendantOfBlog
Description	Tests if an `Id` is a descendant of a blog.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`blogId`	the `Id` of a blog
Return	`boolean`		`true` if the `id` is a descendant of the `blogId,` `false` otherwise
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.
Provider Notes	If `id` is not found return `false.`
Method	getBlogNodeIds
Description	Gets a portion of the hierarchy for the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a blog node
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.
Method	getBlogNodes
Description	Gets a portion of the hierarchy for the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.blogging.BlogNode`		a blog node
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.