OSID Specifications
journaling package
Version 3.1.0
journaling package
Version 3.1.0
| Interface | osid.journaling.JournalHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.journaling.JournalingManager | ||
osid.journaling.JournalingProxyManager | |||
| Description |
This session manages a hierarchy of journals. Journals may
be organized into a hierarchy for organizing or federating. A
parent | ||
| Method | getJournalHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalHierarchy | ||
| Description |
Gets the hierarchy associated with this session. | ||
| Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyJournalHierarchy | ||
| Description |
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 | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootJournal | ||
| Description |
Adds a root journal. | ||
| Parameters | osid.id.Id | journalId | the Id of a journal |
| Errors | ALREADY_EXISTS | journalId is already in hierarchy | |
| NOT_FOUND | journalId is not found | ||
| NULL_ARGUMENT | journalId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootJournal | ||
| Description |
Removes a root journal. | ||
| Parameters | osid.id.Id | journalId | the Id of a journal |
| Errors | NOT_FOUND | journalId is not a root | |
| NULL_ARGUMENT | journalId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildJournal | ||
| Description |
Adds a child to a journal. | ||
| Parameters | osid.id.Id | journalId | the Id of a journal |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | journalId is already a parent of childId | |
| NOT_FOUND | journalId or childId not found | ||
| NULL_ARGUMENT | journalId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildJournal | ||
| Description |
Removes a child from a journal. | ||
| Parameters | osid.id.Id | journalId | the Id of a journal |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | journalId not a parent of childId | |
| NULL_ARGUMENT | journalId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildJournals | ||
| Description |
Removes all children from a journal. | ||
| Parameters | osid.id.Id | journalId | the Id of a journal |
| Errors | NOT_FOUND | journalId not found | |
| NULL_ARGUMENT | journalId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |