Interface BlogHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BlogHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Blogs . 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 Summary

Modifier and Type	Method	Description
boolean	canAccessBlogHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getBlogHierarchy()	Gets the hierarchy associated with this session.
Id	getBlogHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getBlogNodeIds(Id blogId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given blog.
BlogNode	getBlogNodes(Id blogId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given blog.
IdList	getChildBlogIds(Id blogId)	Gets the child Ids of the given blog.
BlogList	getChildBlogs(Id blogId)	Gets the children of the given blog.
IdList	getParentBlogIds(Id blogId)	Gets the parent Ids of the given blog.
BlogList	getParentBlogs(Id blogId)	Gets the parents of the given blog.
IdList	getRootBlogIds()	Gets the root blog Ids in this hierarchy.
BlogList	getRootBlogs()	Gets the root blogs in the blog hierarchy.
boolean	hasChildBlogs(Id blogId)	Tests if a blog has any children.
boolean	hasParentBlogs(Id blogId)	Tests if the Blog has any parents.
boolean	isAncestorOfBlog(Id id, Id blogId)	Tests if an Id is an ancestor of a blog.
boolean	isChildOfBlog(Id id, Id blogId)	Tests if a blog is a direct child of another.
boolean	isDescendantOfBlog(Id id, Id blogId)	Tests if an Id is a descendant of a blog.
boolean	isParentOfBlog(Id id, Id blogId)	Tests if an Id is a direct parent of a blog.
void	useComparativeBlogView()	The returns from the blog methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBlogView()	A complete view of the Blog returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBlogHierarchyId

Id getBlogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBlogHierarchy

Hierarchy getBlogHierarchy()
                    throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessBlogHierarchy

boolean canAccessBlogHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBlogView

void useComparativeBlogView()

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.

usePlenaryBlogView

void usePlenaryBlogView()

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.

getRootBlogIds

IdList getRootBlogIds()
               throws OperationFailedException,
PermissionDeniedException

Gets the root blog Ids in this hierarchy.

Returns:

the root blog Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootBlogs

BlogList getRootBlogs()
               throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root blogs

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentBlogs

boolean hasParentBlogs(Id blogId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Blog has any parents.

Parameters:

blogId - a blog Id

Returns:

true if the blog has parents, false otherwise

Throws:

NotFoundException - blogId is not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfBlog

boolean isParentOfBlog(Id id,
 Id blogId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a blog.

Parameters:

id - an Id

blogId - a blog Id

Returns:

true if this id is a parent of blogId , false otherwise

Throws:

NotFoundException - blogId is not found

NullArgumentException - id or blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentBlogIds

IdList getParentBlogIds(Id blogId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given blog.

Parameters:

blogId - a blog Id

Returns:

the parent Ids of the blog

Throws:

NotFoundException - blogId is not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentBlogs

BlogList getParentBlogs(Id blogId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given blog.

Parameters:

blogId - the Id to query

Returns:

the parents of the blog

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfBlog

boolean isAncestorOfBlog(Id id,
 Id blogId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a blog.

Parameters:

id - an Id

blogId - the Id of a blog

Returns:

true if this id is an ancestor of blogId , false otherwise

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildBlogs

boolean hasChildBlogs(Id blogId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a blog has any children.

Parameters:

blogId - a blogId

Returns:

true if the blogId has children, false otherwise

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfBlog

boolean isChildOfBlog(Id id,
 Id blogId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a blog is a direct child of another.

Parameters:

id - an Id

blogId - the Id of a blog

Returns:

true if the id is a child of blogId , false otherwise

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildBlogIds

IdList getChildBlogIds(Id blogId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given blog.

Parameters:

blogId - the Id to query

Returns:

the children of the blog

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildBlogs

BlogList getChildBlogs(Id blogId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given blog.

Parameters:

blogId - the Id to query

Returns:

the children of the blog

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfBlog

boolean isDescendantOfBlog(Id id,
 Id blogId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a blog.

Parameters:

id - an Id

blogId - the Id of a blog

Returns:

true if the id is a descendant of the blogId , false otherwise

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getBlogNodeIds

Node getBlogNodeIds(Id blogId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given blog.

Parameters:

blogId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a blog node

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlogNodes

BlogNode getBlogNodes(Id blogId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given blog.

Parameters:

blogId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a blog node

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.