public interface RepositoryHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Repository
objects. Each node in the hierarchy is a unique
Repository.
Modifier and Type | Method and Description |
---|---|
void |
addChildRepository(Id repositoryId,
Id childId)
Adds a child to a repository.
|
void |
addRootRepository(Id repositoryId)
Adds a root repository.
|
boolean |
canModifyRepositoryHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getRepositoryHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getRepositoryHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildRepositories(Id repositoryId)
Removes all children from a repository.
|
void |
removeChildRepository(Id repositoryId,
Id childId)
Removes a child from a repository.
|
void |
removeRootRepository(Id repositoryId)
Removes a root repository.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getRepositoryHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyRepositoryHierarchy()
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 addRootRepository(Id repositoryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
repositoryId
- the Id
of a repositoryAlreadyExistsException
- repositoryId
is
already in hierarchyNotFoundException
- repositoryId
not
foundNullArgumentException
- repositoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootRepository(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
repositoryId
- the Id
of a repositoryNotFoundException
- repositoryId
not a
rootNullArgumentException
- repositoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildRepository(Id repositoryId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
repositoryId
- the Id
of a repositorychildId
- the Id
of the new childAlreadyExistsException
- repositoryId
is
already a parent of childId
NotFoundException
- repositoryId
or
childId
not foundNullArgumentException
- repositoryId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildRepository(Id repositoryId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
repositoryId
- the Id
of a repositorychildId
- the Id
of the new childNotFoundException
- repositoryId
not a
parent of childId
NullArgumentException
- repositoryId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildRepositories(Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
repositoryId
- the Id
of a repositoryNotFoundException
- repositoryId
not in
hierarchyNullArgumentException
- repositoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.