Interface BlogHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BlogHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildBlog(Id blogId, Id childId)	Adds a child to a blog.
void	addRootBlog(Id blogId)	Adds a root blog.
boolean	canModifyBlogHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getBlogHierarchy()	Gets the hierarchy associated with this session.
Id	getBlogHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildBlog(Id blogId, Id childId)	Removes a child from a blog.
void	removeChildBlogs(Id blogId)	Removes all children from a blog.
void	removeRootBlog(Id blogId)	Remove a root blog.

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.

canModifyBlogHierarchy

boolean canModifyBlogHierarchy()

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.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootBlog

void addRootBlog(Id blogId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root blog.

Parameters:

blogId - the Id of a blog

Throws:

AlreadyExistsException - blogId is already in hierarchy

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootBlog

void removeRootBlog(Id blogId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Remove a root blog.

Parameters:

blogId - the Id of a blog

Throws:

NotFoundException - blogId is not a root

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildBlog

void addChildBlog(Id blogId,
 Id childId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a blog.

Parameters:

blogId - the Id of a blog

childId - the Id of the new child

Throws:

AlreadyExistsException - blogId is already a parent of childId

NotFoundException - blogId or childId not found

NullArgumentException - blogId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBlog

void removeChildBlog(Id blogId,
 Id childId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a blog.

Parameters:

blogId - the Id of a blog

childId - the Id of the new child

Throws:

NotFoundException - blogId not a parent of childId

NullArgumentException - blogId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBlogs

void removeChildBlogs(Id blogId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a blog.

Parameters:

blogId - the Id of a 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.