public interface LogHierarchyDesignSession extends OsidSession
This session manages a hierarchy of logs. Logs may be organized into a
hierarchy for organizing or federating. A parent Log
includes all of the Ids of its children such that a single root node
contains all of the Ids
of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildLog(Id logId,
Id childId)
Adds a child to a log.
|
void |
addRootLog(Id logId)
Adds a root log.
|
boolean |
canModifyLogHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getLogHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getLogHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildLog(Id logId,
Id childId)
Removes a child from a log.
|
void |
removeChildLogs(Id logId)
Removes all children from a log.
|
void |
removeRootLog(Id logId)
Removes a root log.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getLogHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getLogHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyLogHierarchy()
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 addRootLog(Id logId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
logId
- the Id
of a logAlreadyExistsException
- logId
is
already in hierarchyNotFoundException
- logId
is not foundNullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootLog(Id logId) throws NotFoundException, OperationFailedException, PermissionDeniedException
logId
- the Id
of a logNotFoundException
- logId
is not a rootNullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildLog(Id logId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
logId
- the Id
of a logchildId
- the Id
of the new childAlreadyExistsException
- logId
is
already a parent of childId
NotFoundException
- logId
or
childId
not foundNullArgumentException
- logId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildLog(Id logId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
logId
- the Id
of a logchildId
- the Id
of the new childNotFoundException
- logId
not a parent
of childId
NullArgumentException
- logId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildLogs(Id logId) throws NotFoundException, OperationFailedException, PermissionDeniedException
logId
- the Id
of a logNotFoundException
- logId
not in
hierarchyNullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.