public interface BlogHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Blog
objects. Each node in the hierarchy is a unique Blog.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBlogHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getBlogHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyBlogHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootBlog(Id blogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
blogId
- the Id
of a blogAlreadyExistsException
- blogId
is
already in hierarchyNotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootBlog(Id blogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
blogId
- the Id
of a blogNotFoundException
- blogId
is not a rootNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildBlog(Id blogId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
blogId
- the Id
of a blogchildId
- the Id
of the new childAlreadyExistsException
- blogId
is
already a parent of childId
NotFoundException
- blogId
or
childId
not foundNullArgumentException
- blogId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBlog(Id blogId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
blogId
- the Id
of a blogchildId
- the Id
of the new childNotFoundException
- blogId
not a parent
of childId
NullArgumentException
- blogId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBlogs(Id blogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
blogId
- the Id
of a blogNotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.