public interface JournalHierarchyDesignSession extends OsidSession
This session manages a hierarchy of journals. Journals may be organized
into a hierarchy for organizing or federating. A parent Journal
includes all of the journal entries of its children such that a
single root node contains all of the journal entries of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildJournal(Id journalId,
Id childId)
Adds a child to a journal.
|
void |
addRootJournal(Id journalId)
Adds a root journal.
|
boolean |
canModifyJournalHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getJournalHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getJournalHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildJournal(Id journalId,
Id childId)
Removes a child from a journal.
|
void |
removeChildJournals(Id journalId)
Removes all children from a journal.
|
void |
removeRootJournal(Id journalId)
Removes a root journal.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getJournalHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getJournalHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyJournalHierarchy()
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 addRootJournal(Id journalId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
journalId
- the Id
of a journalAlreadyExistsException
- journalId
is
already in hierarchyNotFoundException
- journalId
is not
foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootJournal(Id journalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
journalId
- the Id
of a journalNotFoundException
- journalId
is not a
rootNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildJournal(Id journalId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
journalId
- the Id
of a journalchildId
- the Id
of the new childAlreadyExistsException
- journalId
is
already a parent of childId
NotFoundException
- journalId
or
childId
not foundNullArgumentException
- journalId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildJournal(Id journalId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
journalId
- the Id
of a journalchildId
- the Id
of the new childNotFoundException
- journalId
not a
parent of childId
NullArgumentException
- journalId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildJournals(Id journalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
journalId
- the Id
of a journalNotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.