Interface | osid.journaling.JournalHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
A user may not be authorized to traverse the entire
hierarchy. Parts of the hierarchy may be made invisible
through omission from the returns of This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | canAccessJournalHierarchy | ||
Description |
Tests if this user can perform hierarchy queries. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeJournalView | ||
Description |
The returns from the journal methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryJournalView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootJournalIds | ||
Description |
Gets the root journal | ||
Return | osid.id.IdList | the root journal Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootJournals | ||
Description |
Gets the root journals in the journal hierarchy. A node
with no parents is an orphan. While all journal | ||
Return | osid.journaling.JournalList | the root journals | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentJournals | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | journalId | a journal Id |
Return | boolean | true if the journal has parents, f alse
otherwise | |
Errors | 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 | isParentOfJournal | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | journalId | the Id of a journal | |
Return | boolean | true if this id is a parent of
journalId, f alse otherwise | |
Errors | NOT_FOUND | journalId is not found | |
NULL_ARGUMENT | id or journalId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentJournalIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | journalId | a journal Id |
Return | osid.id.IdList | the parent Ids of the journal | |
Errors | 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 | getParentJournals | ||
Description |
Gets the parent journals of the given | ||
Parameters | osid.id.Id | journalId | the Id of the Journal to query |
Return | osid.journaling.JournalList | the parent journals of the id | |
Errors | NOT_FOUND | a Journal identified by Id 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 | isAncestorOfJournal | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | journalId | the Id of a journal | |
Return | boolean | tru e if this id is an ancestor of
journalId, false otherwise | |
Errors | NOT_FOUND | journalId is not found | |
NULL_ARGUMENT | id or journalId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildJournals | ||
Description |
Tests if a journal has any children. | ||
Parameters | osid.id.Id | journalId | a journal Id |
Return | boolean | true if the journalId has children,
false otherwise | |
Errors | 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 | isChildOfJournal | ||
Description |
Tests if a journal is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | journalId | the Id of a journal | |
Return | boolean | true if the id is a child of
journalId, false otherwise | |
Errors | NOT_FOUND | journalId is not found | |
NULL_ARGUMENT | id or journalId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildJournalIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | journalId | the Id to query |
Return | osid.id.IdList | the children of the journal | |
Errors | 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 | getChildJournals | ||
Description |
Gets the child journals of the given | ||
Parameters | osid.id.Id | journalId | the Id of the Journal to query |
Return | osid.journaling.JournalList | the child journals of the id | |
Errors | NOT_FOUND | a Journal identified by Id 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 | isDescendantOfJournal | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | journalId | the Id of a journal | |
Return | boolean | true if the id is a descendant of the
journalId, false otherwise | |
Errors | NOT_FOUND | journalId is not found | |
NULL_ARGUMENT | id or journalId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getJournalNodeIds | ||
Description |
Gets a portion of the hierarchy for the given journal. | ||
Parameters | osid.id.Id | journalId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a journal node | |
Errors | 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 | getJournalNodes | ||
Description |
Gets a portion of the hierarchy for the given journal. | ||
Parameters | osid.id.Id | journalId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.journaling.JournalNode | a journal node | |
Errors | 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. |