Interface | osid.logging.LogHierarchySession | ||
---|---|---|---|
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 | getLogHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogHierarchy | ||
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 | canAccessLogHierarchy | ||
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 | useComparativeLogView | ||
Description |
The returns from the log 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 | usePlenaryLogView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootLogIds | ||
Description |
Gets the root log | ||
Return | osid.id.IdList | the root log Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootLogs | ||
Description |
Gets the root logs in the log hierarchy. A node with no
parents is an orphan. While all log | ||
Return | osid.logging.LogList | the root logs | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentLogs | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | logId | the Id of a log |
Return | boolean | true if the log has parents, false otherwise | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfLog | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | logId | the Id of a log | |
Return | boolean | true if this id is a parent of logId,
false otherwise | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | id or logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentLogIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | logId | the Id of a log |
Return | osid.id.IdList | the parent Ids of the log | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentLogs | ||
Description |
Gets the parent logs of the given | ||
Parameters | osid.id.Id | logId | the Id of the Log to query |
Return | osid.logging.LogList | the parent logs of the id | |
Errors | NOT_FOUND | a Log identified by Id is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfLog | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | logId | the Id of a log | |
Return | boolean | true if the id is an ancestor of the
logId, false otherwise | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | id or logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildLogs | ||
Description |
Tests if a log has any children. | ||
Parameters | osid.id.Id | logId | the Id of a log |
Return | boolean | true if the logId has children, false
otherwise | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfLog | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | logId | the Id of a log | |
Return | boolean | true if this id is a child of logId,
false otherwise | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | id or logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildLogIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | logId | the Id to query |
Return | osid.id.IdList | the children of the depot | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildLogs | ||
Description |
Gets the child logs of the given | ||
Parameters | osid.id.Id | logId | the Id of the Log to query |
Return | osid.logging.LogList | the child logs of the id | |
Errors | NOT_FOUND | a Log identified by Id is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfLog | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | logId | the Id of a log | |
Return | boolean | true if the id is a descendant of the
logId, false otherwise | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | id or logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getLogNodeIds | ||
Description |
Gets a portion of the hierarchy for the given log. | ||
Parameters | osid.id.Id | logId | 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 log node | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogNodes | ||
Description |
Gets a portion of the hierarchy for the given log. | ||
Parameters | osid.id.Id | logId | 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.logging.LogNode | a log node | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |